DAdatadog
Status Pages

Update component

Updates an existing component's attributes.

patch/api/v2/statuspages/{page_id}/components/{component_id}

Request

  • Base URL
    https://api.datadoghq.com
  • URL
    https://api.datadoghq.com/api/v2/statuspages/{page_id}/components/{component_id}
  • Auth
    • API key in header DD-API-KEY and API key in header DD-APPLICATION-KEY
    • or OAuth 2
      Authorization code: /oauth2/v1/authorize
      Token URL: /oauth2/v1/token scopes: status_pages_settings_write

Path parameters

page_idstring uuid required
Example:1234abcd-12ab-34cd-56ef-123456abcdef

The ID of the status page.

component_idstring uuid required
Example:1234abcd-12ab-34cd-56ef-123456abcdef

The ID of the component.

Query parameters

includestring

Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page, group.

Request body

Example request

{
  "data": {
    "attributes": {
      "name": "Metrics Intake Service",
      "position": 4
    },
    "id": "1234abcd-12ab-34cd-56ef-123456abcdef",
    "type": "components"
  }
}

Response

OK

Example response

{
  "data": {
    "attributes": {
      "components": [
        {
          "type": "component"
        }
      ],
      "status": "operational",
      "type": "component"
    },
    "relationships": {
      "created_by_user": {
        "data": {
          "type": "users"
        }
      },
      "group": {
        "data": {
          "id": "1234abcd-12ab-34cd-56ef-123456abcdef",
          "type": "components"
        }
      },
      "last_modified_by_user": {
        "data": {
          "type": "users"
        }
      },
      "status_page": {
        "data": {
          "id": "1234abcd-12ab-34cd-56ef-123456abcdef",
          "type": "status_pages"
        }
      }
    },
    "type": "components"
  },
  "included": [
    {
      "type": "users"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.