Update an Opsgenie account

PATCH https://api.ap1.datadoghq.com/api/v2/integration/opsgenie/accounts/{account_id}https://api.ap2.datadoghq.com/api/v2/integration/opsgenie/accounts/{account_id}https://api.datadoghq.eu/api/v2/integration/opsgenie/accounts/{account_id}https://api.ddog-gov.com/api/v2/integration/opsgenie/accounts/{account_id}https://api.us2.ddog-gov.com/api/v2/integration/opsgenie/accounts/{account_id}https://api.datadoghq.com/api/v2/integration/opsgenie/accounts/{account_id}https://api.us3.datadoghq.com/api/v2/integration/opsgenie/accounts/{account_id}https://api.us5.datadoghq.com/api/v2/integration/opsgenie/accounts/{account_id}

Overview

Update a single Opsgenie account in the Datadog Opsgenie integration. This endpoint requires the manage_integrations permission.

Arguments

Path Parameters

Name

Type

Description

account_id [required]

string

The UUID of the Opsgenie account.

Request

Body Data (required)

Opsgenie account payload.

Expand All

Field

Type

Description

data [required]

object

Opsgenie account data for an update request.

attributes [required]

object

The Opsgenie account attributes for an update request.

api_key

string

The Opsgenie API key for your Opsgenie account.

region

enum

The region for the Opsgenie service. Allowed enum values: us,eu,custom

id [required]

string

The ID of the Opsgenie account.

type [required]

enum

Opsgenie account resource type. Allowed enum values: opsgenie-account

default: opsgenie-account

{
  "data": {
    "attributes": {
      "api_key": "00000000-0000-0000-0000-000000000000",
      "region": "us"
    },
    "id": "596da4af-0563-4097-90ff-07230c3f9db3",
    "type": "opsgenie-account"
  }
}

Response

OK

Response containing an Opsgenie account.

Expand All

Field

Type

Description

data [required]

object

Opsgenie account data from a response.

attributes [required]

object

The attributes from an Opsgenie account response.

region

enum

The region for the Opsgenie service. Allowed enum values: us,eu,custom

id [required]

string

The ID of the Opsgenie account.

type [required]

enum

Opsgenie account resource type. Allowed enum values: opsgenie-account

default: opsgenie-account

{
  "data": {
    "attributes": {
      "region": "us"
    },
    "id": "596da4af-0563-4097-90ff-07230c3f9db3",
    "type": "opsgenie-account"
  }
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Forbidden

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Not Found

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

The server cannot process the request because it contains invalid data.

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  ## default
# 

# Path parameters
export account_id="CHANGE_ME"
# Curl command
curl -X PATCH "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/integration/opsgenie/accounts/${account_id}" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "data": { "attributes": { "api_key": "00000000-0000-0000-0000-000000000000", "region": "us" }, "id": "596da4af-0563-4097-90ff-07230c3f9db3", "type": "opsgenie-account" } } EOF