DAdatadog
Software Catalog

Preview catalog entities

post/api/v2/catalog/entity/preview

Request

  • Base URL
    https://api.datadoghq.com
  • URL
    https://api.datadoghq.com/api/v2/catalog/entity/preview
  • 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: apm_service_catalog_read

Response

Accepted

Example response

{
  "data": [
    {
      "relationships": {
        "incidents": {
          "data": [
            {
              "type": "incident"
            }
          ]
        },
        "oncalls": {
          "data": [
            {
              "type": "oncall"
            }
          ]
        },
        "rawSchema": {
          "data": {
            "type": "rawSchema"
          }
        },
        "relatedEntities": {
          "data": [
            {
              "type": "relatedEntity"
            }
          ]
        },
        "schema": {
          "data": {
            "type": "schema"
          }
        }
      },
      "type": "entity"
    }
  ]
}

Changes

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