Update a Statuspage URL setting

PATCH https://api.ap1.datadoghq.com/api/v2/integration/statuspage/url_settings/{statuspage_url_setting_id}https://api.ap2.datadoghq.com/api/v2/integration/statuspage/url_settings/{statuspage_url_setting_id}https://api.datadoghq.eu/api/v2/integration/statuspage/url_settings/{statuspage_url_setting_id}https://api.ddog-gov.com/api/v2/integration/statuspage/url_settings/{statuspage_url_setting_id}https://api.us2.ddog-gov.com/api/v2/integration/statuspage/url_settings/{statuspage_url_setting_id}https://api.datadoghq.com/api/v2/integration/statuspage/url_settings/{statuspage_url_setting_id}https://api.us3.datadoghq.com/api/v2/integration/statuspage/url_settings/{statuspage_url_setting_id}https://api.us5.datadoghq.com/api/v2/integration/statuspage/url_settings/{statuspage_url_setting_id}

Overview

Update a single Statuspage URL setting in your organization. This endpoint requires the manage_integrations permission.

Arguments

Path Parameters

Name

Type

Description

statuspage_url_setting_id [required]

string

The UUID of the Statuspage URL setting.

Request

Body Data (required)

Statuspage URL setting payload.

Expand All

Field

Type

Description

data [required]

object

Statuspage URL setting data for an update request.

attributes [required]

object

The Statuspage URL setting attributes for an update request.

custom_tags

string

Comma-separated list of custom tags to apply to events generated from this Statuspage URL.

url

string

The Statuspage URL to monitor.

id [required]

string

The ID of the Statuspage URL setting.

type [required]

enum

Statuspage URL setting resource type. Allowed enum values: statuspage-url-setting

default: statuspage-url-setting

{
  "data": {
    "attributes": {
      "custom_tags": "team:collaboration-integrations,env:prod",
      "url": "https://example.statuspage.io"
    },
    "id": "596da4af-0563-4097-90ff-07230c3f9db3",
    "type": "statuspage-url-setting"
  }
}

Response

OK

Response containing a Statuspage URL setting.

Expand All

Field

Type

Description

data [required]

object

Statuspage URL setting data from a response.

attributes [required]

object

The attributes from a Statuspage URL setting response.

custom_tags

string

Comma-separated list of custom tags applied to events generated from this Statuspage URL.

url

string

The Statuspage URL being monitored.

id [required]

string

The ID of the Statuspage URL setting.

type [required]

enum

Statuspage URL setting resource type. Allowed enum values: statuspage-url-setting

default: statuspage-url-setting

{
  "data": {
    "attributes": {
      "custom_tags": "team:collaboration-integrations,env:prod",
      "url": "https://example.statuspage.io"
    },
    "id": "596da4af-0563-4097-90ff-07230c3f9db3",
    "type": "statuspage-url-setting"
  }
}

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"
  ]
}

Conflict

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "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 statuspage_url_setting_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/statuspage/url_settings/${statuspage_url_setting_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": { "custom_tags": "team:collaboration-integrations", "url": "https://example.statuspage.io" }, "id": "596da4af-0563-4097-90ff-07230c3f9db3", "type": "statuspage-url-setting" } } EOF