DAdatadog
Software Catalog

Get a list of entity relations

Get a list of entity relations from Software Catalog.

get/api/v2/catalog/relation

Request

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

Query parameters

page[offset]integer

Specific offset to use as the beginning of the returned page.

page[limit]integer

Maximum number of relations in the response.

filter[type]'RelationTypeOwns' | 'RelationTypeOwnedBy' | 'RelationTypeDependsOn' | 'RelationTypeDependencyOf' | 'RelationTypePartsOf' | 'RelationTypeHasPart' | 'RelationTypeOtherOwns' | 'RelationTypeOtherOwnedBy' | 'RelationTypeImplementedBy' | 'RelationTypeImplements'

Supported relation types.

Filter relations by type.

filter[from_ref]string

Filter relations by the reference of the first entity in the relation.

filter[to_ref]string

Filter relations by the reference of the second entity in the relation.

include'entity' | 'schema'

Supported include types for relations.

Include relationship data.

includeDiscoveredboolean

If true, includes relationships discovered by APM and USM.

Response

OK

Example response

{
  "links": {
    "next": "/api/v2/catalog/relation?filter[from_ref]=service:service-catalog&include=entity&page[limit]=2&page[offset]=2",
    "self": "/api/v2/catalog/relation?filter[from_ref]=service:service-catalog&include=entity&page[limit]=2&page[offset]=0"
  }
}

Changes

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