- 필수 기능
- 시작하기
- Glossary
- 표준 속성
- Guides
- Agent
- 통합
- 개방형텔레메트리
- 개발자
- API
- Datadog Mobile App
- CoScreen
- Cloudcraft
- 앱 내
- 서비스 관리
- 인프라스트럭처
- 애플리케이션 성능
- APM
- Continuous Profiler
- 스팬 시각화
- 데이터 스트림 모니터링
- 데이터 작업 모니터링
- 디지털 경험
- 소프트웨어 제공
- 보안
- AI Observability
- 로그 관리
- 관리
API to create, update, retrieve and delete Software Catalog entities.
GET https://api.ap1.datadoghq.com/api/v2/catalog/entityhttps://api.datadoghq.eu/api/v2/catalog/entityhttps://api.ddog-gov.com/api/v2/catalog/entityhttps://api.datadoghq.com/api/v2/catalog/entityhttps://api.us3.datadoghq.com/api/v2/catalog/entityhttps://api.us5.datadoghq.com/api/v2/catalog/entity
Get a list of entities from Software Catalog.
This endpoint requires the apm_service_catalog_read
authorization scope.
이름
유형
설명
page[offset]
integer
Specific offset to use as the beginning of the returned page.
page[limit]
integer
Maximum number of entities in the response.
fitler[id]
string
Filter entities by UUID
fitler[ref]
string
Filter entities by reference
fitler[name]
string
Filter entities by name
fitler[kind]
string
Filter entities by kind
fitler[owner]
string
Filter entities by owner
fitler[relation][type]
enum
Filter entities by relation type
Allowed enum values: RelationTypeOwns, RelationTypeOwnedBy, RelationTypeDependsOn, RelationTypeDependencyOf, RelationTypePartsOf, RelationTypeHasPart, RelationTypeOtherOwns, RelationTypeOtherOwnedBy, RelationTypeImplementedBy, RelationTypeImplements
fitler[exclude_snapshot]
string
Filter entities by excluding snapshotted entities
include
enum
include relationship data
Allowed enum values: schema, raw_schema, oncall, incident, relation
OK
List entity response.
항목
유형
설명
data
[object]
List of entity data.
attributes
object
Entity attributes.
apiVersion
string
The api version.
description
string
The description.
displayName
string
The display name.
kind
string
The kind.
name
string
The name.
namespace
string
The namespace.
owner
string
The owner.
tags
[string]
The tags.
id
string
Entity id.
meta
object
Entity metadata.
createdAt
string
The creation time.
ingestionSource
string
The ingestion source.
modifiedAt
string
The modification time.
origin
string
The origin.
relationships
object
Entity relationships.
incidents
object
Entity to incidents relationship.
data
[object]
Relationships.
id
string
Associated data id.
type
string
Relationship type.
oncall
object
Entity to oncalls relationship.
data
[object]
Relationships.
id
string
Associated data id.
type
string
Relationship type.
rawSchema
object
Entity to raw schema relationship.
data
object
Relationship entry.
id
string
Associated data id.
type
string
Relationship type.
relatedEntities
object
Entity to related entities relationship.
data
[object]
Relationships.
id
string
Associated data id.
type
string
Relationship type.
schema
object
Entity to detail schema relationship.
data
object
Relationship entry.
id
string
Associated data id.
type
string
Relationship type.
type
string
Entity.
included
[ <oneOf>]
List entity response included.
Option 1
object
Included detail entity schema.
attributes
object
Included schema.
schema
<oneOf>
Entity schema v3.
Option 1
object
Schema for service entities
apiVersion [required]
enum
The schema version of entity type. The field is known as schema-version in the previous version
Allowed enum values: v3
datadog
object
Datadog product integrations for the service entity
codeLocations
[object]
Schema for mapping source code locations to an entity
paths
[string]
The paths (glob) to the source code of the service
repositoryURL
string
The repository path of the source code of the entity
events
[object]
Events associations
name
string
The name of the query
query
string
The query to run
logs
[object]
Logs association
name
string
The name of the query
query
string
The query to run
performanceData
object
Performance stats association
tags
[string]
A list of APM entity tags that associates the APM Stats data with the entity
pipelines
object
CI Pipelines association
fingerprints
[string]
A list of CI Fingerprints that associate CI Pipelines with the entity
extensions
object
Custom extensions. This is the free-formed field to send client side metadata. No Datadog features are affected by this field.
integrations
object
A base schema for defining third party integrations
opsgenie
object
An Opsgenie integration schema
region
string
The region for the Opsgenie integration.
serviceURL [required]
string
The service url for the Opsgenie integration.
pagerduty
object
An PagerDuty integration schema
serviceURL [required]
string
The service url for the PagerDuty integration.
kind [required]
enum
The definition of Entity V3 Service Kind object.
Allowed enum values: service
metadata [required]
object
The definition of Entity V3 Metadata object.
additionalOwners
[]
The additional owners of the entity, usually a team
name [required]
string
Team name
type
string
Team type
contacts
[object]
A list of contacts for the entity
contact [required]
string
Contact value
name
string
Contact name
type [required]
string
Contact type.
description
string
Short description of the entity. The UI can leverage the description for display
displayName
string
User friendly name of the entity. The UI can leverage the display name for display
id
string
A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.
inheritFrom
string
The entity reference from which to inherit metadata
links
[object]
A list of links for the entity
name [required]
string
Link name
provider
string
Link provider.
type [required]
string
Link type.
default: other
url [required]
string
Link url
managed
object
A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.
name [required]
string
Unique name given to an entity under the kind/namespace
namespace
string
Namespace is a part of unique identifier. It has a default value of 'default'
owner
The owner of the entity, usually a team
name
string
Team name
tags
[string]
A set of custom tags
spec
object
The definition of Entity V3 Service Spec object.
dependsOn
[string]
A list of components the service depends on
languages
[string]
The service's programming language.
lifecycle
string
The lifecycle state of the component.
tier
string
The importance of the component
type
string
The type of service
Option 2
object
Schema for datastore entities
apiVersion [required]
enum
The schema version of entity type. The field is known as schema-version in the previous version
Allowed enum values: v3
datadog
object
Datadog product integrations for the datastore entity
events
[object]
Events associations
name
string
The name of the query
query
string
The query to run
logs
[object]
Logs association
name
string
The name of the query
query
string
The query to run
performanceData
object
Performance stats association
tags
[string]
A list of APM entity tags that associates the APM Stats data with the entity
extensions
object
Custom extensions. This is the free-formed field to send client side metadata. No Datadog features are affected by this field.
integrations
object
A base schema for defining third party integrations
opsgenie
object
An Opsgenie integration schema
region
string
The region for the Opsgenie integration.
serviceURL [required]
string
The service url for the Opsgenie integration.
pagerduty
object
An PagerDuty integration schema
serviceURL [required]
string
The service url for the PagerDuty integration.
kind [required]
enum
The definition of Entity V3 Datastore Kind object.
Allowed enum values: datastore
metadata [required]
object
The definition of Entity V3 Metadata object.
additionalOwners
[]
The additional owners of the entity, usually a team
name [required]
string
Team name
type
string
Team type
contacts
[object]
A list of contacts for the entity
contact [required]
string
Contact value
name
string
Contact name
type [required]
string
Contact type.
description
string
Short description of the entity. The UI can leverage the description for display
displayName
string
User friendly name of the entity. The UI can leverage the display name for display
id
string
A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.
inheritFrom
string
The entity reference from which to inherit metadata
links
[object]
A list of links for the entity
name [required]
string
Link name
provider
string
Link provider.
type [required]
string
Link type.
default: other
url [required]
string
Link url
managed
object
A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.
name [required]
string
Unique name given to an entity under the kind/namespace
namespace
string
Namespace is a part of unique identifier. It has a default value of 'default'
owner
The owner of the entity, usually a team
name
string
Team name
tags
[string]
A set of custom tags
spec
object
The definition of Entity V3 Datastore Spec object.
lifecycle
string
The lifecycle state of the datastore.
tier
string
The importance of the datastore
type
string
The type of datastore
Option 3
object
Schema for queue entities
apiVersion [required]
enum
The schema version of entity type. The field is known as schema-version in the previous version
Allowed enum values: v3
datadog
object
Datadog product integrations for the datastore entity
events
[object]
Events associations
name
string
The name of the query
query
string
The query to run
logs
[object]
Logs association
name
string
The name of the query
query
string
The query to run
performanceData
object
Performance stats association
tags
[string]
A list of APM entity tags that associates the APM Stats data with the entity
extensions
object
Custom extensions. This is the free-formed field to send client side metadata. No Datadog features are affected by this field.
integrations
object
A base schema for defining third party integrations
opsgenie
object
An Opsgenie integration schema
region
string
The region for the Opsgenie integration.
serviceURL [required]
string
The service url for the Opsgenie integration.
pagerduty
object
An PagerDuty integration schema
serviceURL [required]
string
The service url for the PagerDuty integration.
kind [required]
enum
The definition of Entity V3 Queue Kind object.
Allowed enum values: queue
metadata [required]
object
The definition of Entity V3 Metadata object.
additionalOwners
[]
The additional owners of the entity, usually a team
name [required]
string
Team name
type
string
Team type
contacts
[object]
A list of contacts for the entity
contact [required]
string
Contact value
name
string
Contact name
type [required]
string
Contact type.
description
string
Short description of the entity. The UI can leverage the description for display
displayName
string
User friendly name of the entity. The UI can leverage the display name for display
id
string
A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.
inheritFrom
string
The entity reference from which to inherit metadata
links
[object]
A list of links for the entity
name [required]
string
Link name
provider
string
Link provider.
type [required]
string
Link type.
default: other
url [required]
string
Link url
managed
object
A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.
name [required]
string
Unique name given to an entity under the kind/namespace
namespace
string
Namespace is a part of unique identifier. It has a default value of 'default'
owner
The owner of the entity, usually a team
name
string
Team name
tags
[string]
A set of custom tags
spec
object
The definition of Entity V3 Queue Spec object.
lifecycle
string
The lifecycle state of the queue.
tier
string
The importance of the queue
type
string
The type of queue
Option 4
object
Schema for system entities
apiVersion [required]
enum
The schema version of entity type. The field is known as schema-version in the previous version
Allowed enum values: v3
datadog
object
Datadog product integrations for the service entity
events
[object]
Events associations
name
string
The name of the query
query
string
The query to run
logs
[object]
Logs association
name
string
The name of the query
query
string
The query to run
performanceData
object
Performance stats association
tags
[string]
A list of APM entity tags that associates the APM Stats data with the entity
pipelines
object
CI Pipelines association
fingerprints
[string]
A list of CI Fingerprints that associate CI Pipelines with the entity
extensions
object
Custom extensions. This is the free-formed field to send client side metadata. No Datadog features are affected by this field.
integrations
object
A base schema for defining third party integrations
opsgenie
object
An Opsgenie integration schema
region
string
The region for the Opsgenie integration.
serviceURL [required]
string
The service url for the Opsgenie integration.
pagerduty
object
An PagerDuty integration schema
serviceURL [required]
string
The service url for the PagerDuty integration.
kind [required]
enum
The definition of Entity V3 System Kind object.
Allowed enum values: system
metadata [required]
object
The definition of Entity V3 Metadata object.
additionalOwners
[]
The additional owners of the entity, usually a team
name [required]
string
Team name
type
string
Team type
contacts
[object]
A list of contacts for the entity
contact [required]
string
Contact value
name
string
Contact name
type [required]
string
Contact type.
description
string
Short description of the entity. The UI can leverage the description for display
displayName
string
User friendly name of the entity. The UI can leverage the display name for display
id
string
A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.
inheritFrom
string
The entity reference from which to inherit metadata
links
[object]
A list of links for the entity
name [required]
string
Link name
provider
string
Link provider.
type [required]
string
Link type.
default: other
url [required]
string
Link url
managed
object
A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.
name [required]
string
Unique name given to an entity under the kind/namespace
namespace
string
Namespace is a part of unique identifier. It has a default value of 'default'
owner
The owner of the entity, usually a team
name
string
Team name
tags
[string]
A set of custom tags
spec
object
The definition of Entity V3 System Spec object.
components
[string]
A list of components belongs to the system.
lifecycle
string
The lifecycle state of the component.
tier
string
An entity reference to the owner of the component.
id
string
Entity id.
type
string
Schema type.
Option 2
object
Included raw schema.
attributes
object
Included raw schema attributes.
rawSchema
string
Schema from user input in base64 encoding.
id
string
Raw schema id.
type
string
Raw schema type.
Option 3
object
Included related entity.
attributes
object
Related entity attributes.
kind
string
Entity kind.
name
string
Entity name.
namespace
string
Entity namespace.
type
string
Entity relation type to the associated entity.
id
string
Entity UUID.
meta
object
Included related entity meta.
createdAt
date-time
Entity creation time.
defined_by
string
Entity relation defined by.
modifiedAt
date-time
Entity modification time.
source
string
Entity relation source.
type
string
Related entity.
Option 4
object
Included oncall.
attributes
object
Included related oncall attributes.
escalations
[object]
Oncall escalations
string
Oncall email.
escalationLevel
int64
Oncall level.
name
string
Oncall name.
provider
string
Oncall provider.
id
string
Oncall ID.
type
string
Oncall type.
Option 5
object
Included incident.
attributes
object
Incident attributes.
createdAt
date-time
Incident creation time.
htmlURL
string
Incident URL.
provider
string
Incident provider.
status
string
Incident status.
title
string
Incident title.
id
string
Incident id.
type
string
Incident description.
links
object
List entity response links.
next
string
next link.
previous
string
previous link.
self
string
current link.
meta
object
Entity metadata.
count
int64
Total entities count.
includeCount
int64
Total included data count.
{
"data": [
{
"attributes": {
"apiVersion": "string",
"description": "string",
"displayName": "string",
"kind": "string",
"name": "string",
"namespace": "string",
"owner": "string",
"tags": []
},
"id": "string",
"meta": {
"createdAt": "string",
"ingestionSource": "string",
"modifiedAt": "string",
"origin": "string"
},
"relationships": {
"incidents": {
"data": [
{
"id": "string",
"type": "string"
}
]
},
"oncall": {
"data": [
{
"id": "string",
"type": "string"
}
]
},
"rawSchema": {
"data": {
"id": "string",
"type": "string"
}
},
"relatedEntities": {
"data": [
{
"id": "string",
"type": "string"
}
]
},
"schema": {
"data": {
"id": "string",
"type": "string"
}
}
},
"type": "string"
}
],
"included": [
{
"attributes": {
"schema": {
"apiVersion": "v3",
"datadog": {
"codeLocations": [
{
"paths": [],
"repositoryURL": "string"
}
],
"events": [
{
"name": "string",
"query": "string"
}
],
"logs": [
{
"name": "string",
"query": "string"
}
],
"performanceData": {
"tags": []
},
"pipelines": {
"fingerprints": []
}
},
"extensions": {},
"integrations": {
"opsgenie": {
"region": "string",
"serviceURL": "https://www.opsgenie.com/service/shopping-cart"
},
"pagerduty": {
"serviceURL": "https://www.pagerduty.com/service-directory/Pshopping-cart"
}
},
"kind": "service",
"metadata": {
"additionalOwners": [
{
"name": "",
"type": "string"
}
],
"contacts": [
{
"contact": "https://slack/",
"name": "string",
"type": "slack"
}
],
"description": "string",
"displayName": "string",
"id": "4b163705-23c0-4573-b2fb-f6cea2163fcb",
"inheritFrom": "application:default/myapp",
"links": [
{
"name": "mylink",
"provider": "string",
"type": "link",
"url": "https://mylink"
}
],
"managed": {},
"name": "myService",
"namespace": "default",
"owner": {
"name": "string"
},
"tags": [
"this:tag",
"that:tag"
]
},
"spec": {
"dependsOn": [],
"languages": [],
"lifecycle": "string",
"tier": "string",
"type": "string"
}
}
},
"id": "string",
"type": "string"
}
],
"links": {
"next": "string",
"previous": "string",
"self": "string"
},
"meta": {
"count": "integer",
"includeCount": "integer"
}
}
Forbidden
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/catalog/entity" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
POST https://api.ap1.datadoghq.com/api/v2/catalog/entityhttps://api.datadoghq.eu/api/v2/catalog/entityhttps://api.ddog-gov.com/api/v2/catalog/entityhttps://api.datadoghq.com/api/v2/catalog/entityhttps://api.us3.datadoghq.com/api/v2/catalog/entityhttps://api.us5.datadoghq.com/api/v2/catalog/entity
Create or update entities in Software Catalog.
This endpoint requires the apm_service_catalog_write
authorization scope.
Entity YAML/JSON.
항목
유형
설명
Option 1
<oneOf>
Entity schema v3.
Option 1
object
Schema for service entities
apiVersion [required]
enum
The schema version of entity type. The field is known as schema-version in the previous version
Allowed enum values: v3
datadog
object
Datadog product integrations for the service entity
codeLocations
[object]
Schema for mapping source code locations to an entity
paths
[string]
The paths (glob) to the source code of the service
repositoryURL
string
The repository path of the source code of the entity
events
[object]
Events associations
name
string
The name of the query
query
string
The query to run
logs
[object]
Logs association
name
string
The name of the query
query
string
The query to run
performanceData
object
Performance stats association
tags
[string]
A list of APM entity tags that associates the APM Stats data with the entity
pipelines
object
CI Pipelines association
fingerprints
[string]
A list of CI Fingerprints that associate CI Pipelines with the entity
extensions
object
Custom extensions. This is the free-formed field to send client side metadata. No Datadog features are affected by this field.
integrations
object
A base schema for defining third party integrations
opsgenie
object
An Opsgenie integration schema
region
string
The region for the Opsgenie integration.
serviceURL [required]
string
The service url for the Opsgenie integration.
pagerduty
object
An PagerDuty integration schema
serviceURL [required]
string
The service url for the PagerDuty integration.
kind [required]
enum
The definition of Entity V3 Service Kind object.
Allowed enum values: service
metadata [required]
object
The definition of Entity V3 Metadata object.
additionalOwners
[]
The additional owners of the entity, usually a team
name [required]
string
Team name
type
string
Team type
contacts
[object]
A list of contacts for the entity
contact [required]
string
Contact value
name
string
Contact name
type [required]
string
Contact type.
description
string
Short description of the entity. The UI can leverage the description for display
displayName
string
User friendly name of the entity. The UI can leverage the display name for display
id
string
A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.
inheritFrom
string
The entity reference from which to inherit metadata
links
[object]
A list of links for the entity
name [required]
string
Link name
provider
string
Link provider.
type [required]
string
Link type.
default: other
url [required]
string
Link url
managed
object
A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.
name [required]
string
Unique name given to an entity under the kind/namespace
namespace
string
Namespace is a part of unique identifier. It has a default value of 'default'
owner
The owner of the entity, usually a team
name
string
Team name
tags
[string]
A set of custom tags
spec
object
The definition of Entity V3 Service Spec object.
dependsOn
[string]
A list of components the service depends on
languages
[string]
The service's programming language.
lifecycle
string
The lifecycle state of the component.
tier
string
The importance of the component
type
string
The type of service
Option 2
object
Schema for datastore entities
apiVersion [required]
enum
The schema version of entity type. The field is known as schema-version in the previous version
Allowed enum values: v3
datadog
object
Datadog product integrations for the datastore entity
events
[object]
Events associations
name
string
The name of the query
query
string
The query to run
logs
[object]
Logs association
name
string
The name of the query
query
string
The query to run
performanceData
object
Performance stats association
tags
[string]
A list of APM entity tags that associates the APM Stats data with the entity
extensions
object
Custom extensions. This is the free-formed field to send client side metadata. No Datadog features are affected by this field.
integrations
object
A base schema for defining third party integrations
opsgenie
object
An Opsgenie integration schema
region
string
The region for the Opsgenie integration.
serviceURL [required]
string
The service url for the Opsgenie integration.
pagerduty
object
An PagerDuty integration schema
serviceURL [required]
string
The service url for the PagerDuty integration.
kind [required]
enum
The definition of Entity V3 Datastore Kind object.
Allowed enum values: datastore
metadata [required]
object
The definition of Entity V3 Metadata object.
additionalOwners
[]
The additional owners of the entity, usually a team
name [required]
string
Team name
type
string
Team type
contacts
[object]
A list of contacts for the entity
contact [required]
string
Contact value
name
string
Contact name
type [required]
string
Contact type.
description
string
Short description of the entity. The UI can leverage the description for display
displayName
string
User friendly name of the entity. The UI can leverage the display name for display
id
string
A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.
inheritFrom
string
The entity reference from which to inherit metadata
links
[object]
A list of links for the entity
name [required]
string
Link name
provider
string
Link provider.
type [required]
string
Link type.
default: other
url [required]
string
Link url
managed
object
A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.
name [required]
string
Unique name given to an entity under the kind/namespace
namespace
string
Namespace is a part of unique identifier. It has a default value of 'default'
owner
The owner of the entity, usually a team
name
string
Team name
tags
[string]
A set of custom tags
spec
object
The definition of Entity V3 Datastore Spec object.
lifecycle
string
The lifecycle state of the datastore.
tier
string
The importance of the datastore
type
string
The type of datastore
Option 3
object
Schema for queue entities
apiVersion [required]
enum
The schema version of entity type. The field is known as schema-version in the previous version
Allowed enum values: v3
datadog
object
Datadog product integrations for the datastore entity
events
[object]
Events associations
name
string
The name of the query
query
string
The query to run
logs
[object]
Logs association
name
string
The name of the query
query
string
The query to run
performanceData
object
Performance stats association
tags
[string]
A list of APM entity tags that associates the APM Stats data with the entity
extensions
object
Custom extensions. This is the free-formed field to send client side metadata. No Datadog features are affected by this field.
integrations
object
A base schema for defining third party integrations
opsgenie
object
An Opsgenie integration schema
region
string
The region for the Opsgenie integration.
serviceURL [required]
string
The service url for the Opsgenie integration.
pagerduty
object
An PagerDuty integration schema
serviceURL [required]
string
The service url for the PagerDuty integration.
kind [required]
enum
The definition of Entity V3 Queue Kind object.
Allowed enum values: queue
metadata [required]
object
The definition of Entity V3 Metadata object.
additionalOwners
[]
The additional owners of the entity, usually a team
name [required]
string
Team name
type
string
Team type
contacts
[object]
A list of contacts for the entity
contact [required]
string
Contact value
name
string
Contact name
type [required]
string
Contact type.
description
string
Short description of the entity. The UI can leverage the description for display
displayName
string
User friendly name of the entity. The UI can leverage the display name for display
id
string
A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.
inheritFrom
string
The entity reference from which to inherit metadata
links
[object]
A list of links for the entity
name [required]
string
Link name
provider
string
Link provider.
type [required]
string
Link type.
default: other
url [required]
string
Link url
managed
object
A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.
name [required]
string
Unique name given to an entity under the kind/namespace
namespace
string
Namespace is a part of unique identifier. It has a default value of 'default'
owner
The owner of the entity, usually a team
name
string
Team name
tags
[string]
A set of custom tags
spec
object
The definition of Entity V3 Queue Spec object.
lifecycle
string
The lifecycle state of the queue.
tier
string
The importance of the queue
type
string
The type of queue
Option 4
object
Schema for system entities
apiVersion [required]
enum
The schema version of entity type. The field is known as schema-version in the previous version
Allowed enum values: v3
datadog
object
Datadog product integrations for the service entity
events
[object]
Events associations
name
string
The name of the query
query
string
The query to run
logs
[object]
Logs association
name
string
The name of the query
query
string
The query to run
performanceData
object
Performance stats association
tags
[string]
A list of APM entity tags that associates the APM Stats data with the entity
pipelines
object
CI Pipelines association
fingerprints
[string]
A list of CI Fingerprints that associate CI Pipelines with the entity
extensions
object
Custom extensions. This is the free-formed field to send client side metadata. No Datadog features are affected by this field.
integrations
object
A base schema for defining third party integrations
opsgenie
object
An Opsgenie integration schema
region
string
The region for the Opsgenie integration.
serviceURL [required]
string
The service url for the Opsgenie integration.
pagerduty
object
An PagerDuty integration schema
serviceURL [required]
string
The service url for the PagerDuty integration.
kind [required]
enum
The definition of Entity V3 System Kind object.
Allowed enum values: system
metadata [required]
object
The definition of Entity V3 Metadata object.
additionalOwners
[]
The additional owners of the entity, usually a team
name [required]
string
Team name
type
string
Team type
contacts
[object]
A list of contacts for the entity
contact [required]
string
Contact value
name
string
Contact name
type [required]
string
Contact type.
description
string
Short description of the entity. The UI can leverage the description for display
displayName
string
User friendly name of the entity. The UI can leverage the display name for display
id
string
A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.
inheritFrom
string
The entity reference from which to inherit metadata
links
[object]
A list of links for the entity
name [required]
string
Link name
provider
string
Link provider.
type [required]
string
Link type.
default: other
url [required]
string
Link url
managed
object
A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.
name [required]
string
Unique name given to an entity under the kind/namespace
namespace
string
Namespace is a part of unique identifier. It has a default value of 'default'
owner
The owner of the entity, usually a team
name
string
Team name
tags
[string]
A set of custom tags
spec
object
The definition of Entity V3 System Spec object.
components
[string]
A list of components belongs to the system.
lifecycle
string
The lifecycle state of the component.
tier
string
An entity reference to the owner of the component.
Option 2
string
Entity definition in raw JSON/YAML representation.
{
"apiVersion": "v3",
"datadog": {
"codeLocations": [
{
"paths": []
}
],
"events": [
{}
],
"logs": [
{}
],
"performanceData": {
"tags": []
},
"pipelines": {
"fingerprints": []
}
},
"integrations": {
"opsgenie": {
"serviceURL": "https://www.opsgenie.com/service/shopping-cart"
},
"pagerduty": {
"serviceURL": "https://www.pagerduty.com/service-directory/Pshopping-cart"
}
},
"kind": "service",
"metadata": {
"additionalOwners": [],
"contacts": [
{
"contact": "https://slack/",
"type": "slack"
}
],
"id": "4b163705-23c0-4573-b2fb-f6cea2163fcb",
"inheritFrom": "application:default/myapp",
"links": [
{
"name": "mylink",
"type": "link",
"url": "https://mylink"
}
],
"name": "service-examplesoftwarecatalog",
"tags": [
"this:tag",
"that:tag"
]
},
"spec": {
"dependsOn": [],
"languages": []
}
}
ACCEPTED
Upsert entity response.
항목
유형
설명
data
[object]
List of entity data.
attributes
object
Entity attributes.
apiVersion
string
The api version.
description
string
The description.
displayName
string
The display name.
kind
string
The kind.
name
string
The name.
namespace
string
The namespace.
owner
string
The owner.
tags
[string]
The tags.
id
string
Entity id.
meta
object
Entity metadata.
createdAt
string
The creation time.
ingestionSource
string
The ingestion source.
modifiedAt
string
The modification time.
origin
string
The origin.
relationships
object
Entity relationships.
incidents
object
Entity to incidents relationship.
data
[object]
Relationships.
id
string
Associated data id.
type
string
Relationship type.
oncall
object
Entity to oncalls relationship.
data
[object]
Relationships.
id
string
Associated data id.
type
string
Relationship type.
rawSchema
object
Entity to raw schema relationship.
data
object
Relationship entry.
id
string
Associated data id.
type
string
Relationship type.
relatedEntities
object
Entity to related entities relationship.
data
[object]
Relationships.
id
string
Associated data id.
type
string
Relationship type.
schema
object
Entity to detail schema relationship.
data
object
Relationship entry.
id
string
Associated data id.
type
string
Relationship type.
type
string
Entity.
included
[ <oneOf>]
Upsert entity response included.
Option 1
object
Included detail entity schema.
attributes
object
Included schema.
schema
<oneOf>
Entity schema v3.
Option 1
object
Schema for service entities
apiVersion [required]
enum
The schema version of entity type. The field is known as schema-version in the previous version
Allowed enum values: v3
datadog
object
Datadog product integrations for the service entity
codeLocations
[object]
Schema for mapping source code locations to an entity
paths
[string]
The paths (glob) to the source code of the service
repositoryURL
string
The repository path of the source code of the entity
events
[object]
Events associations
name
string
The name of the query
query
string
The query to run
logs
[object]
Logs association
name
string
The name of the query
query
string
The query to run
performanceData
object
Performance stats association
tags
[string]
A list of APM entity tags that associates the APM Stats data with the entity
pipelines
object
CI Pipelines association
fingerprints
[string]
A list of CI Fingerprints that associate CI Pipelines with the entity
extensions
object
Custom extensions. This is the free-formed field to send client side metadata. No Datadog features are affected by this field.
integrations
object
A base schema for defining third party integrations
opsgenie
object
An Opsgenie integration schema
region
string
The region for the Opsgenie integration.
serviceURL [required]
string
The service url for the Opsgenie integration.
pagerduty
object
An PagerDuty integration schema
serviceURL [required]
string
The service url for the PagerDuty integration.
kind [required]
enum
The definition of Entity V3 Service Kind object.
Allowed enum values: service
metadata [required]
object
The definition of Entity V3 Metadata object.
additionalOwners
[]
The additional owners of the entity, usually a team
name [required]
string
Team name
type
string
Team type
contacts
[object]
A list of contacts for the entity
contact [required]
string
Contact value
name
string
Contact name
type [required]
string
Contact type.
description
string
Short description of the entity. The UI can leverage the description for display
displayName
string
User friendly name of the entity. The UI can leverage the display name for display
id
string
A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.
inheritFrom
string
The entity reference from which to inherit metadata
links
[object]
A list of links for the entity
name [required]
string
Link name
provider
string
Link provider.
type [required]
string
Link type.
default: other
url [required]
string
Link url
managed
object
A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.
name [required]
string
Unique name given to an entity under the kind/namespace
namespace
string
Namespace is a part of unique identifier. It has a default value of 'default'
owner
The owner of the entity, usually a team
name
string
Team name
tags
[string]
A set of custom tags
spec
object
The definition of Entity V3 Service Spec object.
dependsOn
[string]
A list of components the service depends on
languages
[string]
The service's programming language.
lifecycle
string
The lifecycle state of the component.
tier
string
The importance of the component
type
string
The type of service
Option 2
object
Schema for datastore entities
apiVersion [required]
enum
The schema version of entity type. The field is known as schema-version in the previous version
Allowed enum values: v3
datadog
object
Datadog product integrations for the datastore entity
events
[object]
Events associations
name
string
The name of the query
query
string
The query to run
logs
[object]
Logs association
name
string
The name of the query
query
string
The query to run
performanceData
object
Performance stats association
tags
[string]
A list of APM entity tags that associates the APM Stats data with the entity
extensions
object
Custom extensions. This is the free-formed field to send client side metadata. No Datadog features are affected by this field.
integrations
object
A base schema for defining third party integrations
opsgenie
object
An Opsgenie integration schema
region
string
The region for the Opsgenie integration.
serviceURL [required]
string
The service url for the Opsgenie integration.
pagerduty
object
An PagerDuty integration schema
serviceURL [required]
string
The service url for the PagerDuty integration.
kind [required]
enum
The definition of Entity V3 Datastore Kind object.
Allowed enum values: datastore
metadata [required]
object
The definition of Entity V3 Metadata object.
additionalOwners
[]
The additional owners of the entity, usually a team
name [required]
string
Team name
type
string
Team type
contacts
[object]
A list of contacts for the entity
contact [required]
string
Contact value
name
string
Contact name
type [required]
string
Contact type.
description
string
Short description of the entity. The UI can leverage the description for display
displayName
string
User friendly name of the entity. The UI can leverage the display name for display
id
string
A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.
inheritFrom
string
The entity reference from which to inherit metadata
links
[object]
A list of links for the entity
name [required]
string
Link name
provider
string
Link provider.
type [required]
string
Link type.
default: other
url [required]
string
Link url
managed
object
A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.
name [required]
string
Unique name given to an entity under the kind/namespace
namespace
string
Namespace is a part of unique identifier. It has a default value of 'default'
owner
The owner of the entity, usually a team
name
string
Team name
tags
[string]
A set of custom tags
spec
object
The definition of Entity V3 Datastore Spec object.
lifecycle
string
The lifecycle state of the datastore.
tier
string
The importance of the datastore
type
string
The type of datastore
Option 3
object
Schema for queue entities
apiVersion [required]
enum
The schema version of entity type. The field is known as schema-version in the previous version
Allowed enum values: v3
datadog
object
Datadog product integrations for the datastore entity
events
[object]
Events associations
name
string
The name of the query
query
string
The query to run
logs
[object]
Logs association
name
string
The name of the query
query
string
The query to run
performanceData
object
Performance stats association
tags
[string]
A list of APM entity tags that associates the APM Stats data with the entity
extensions
object
Custom extensions. This is the free-formed field to send client side metadata. No Datadog features are affected by this field.
integrations
object
A base schema for defining third party integrations
opsgenie
object
An Opsgenie integration schema
region
string
The region for the Opsgenie integration.
serviceURL [required]
string
The service url for the Opsgenie integration.
pagerduty
object
An PagerDuty integration schema
serviceURL [required]
string
The service url for the PagerDuty integration.
kind [required]
enum
The definition of Entity V3 Queue Kind object.
Allowed enum values: queue
metadata [required]
object
The definition of Entity V3 Metadata object.
additionalOwners
[]
The additional owners of the entity, usually a team
name [required]
string
Team name
type
string
Team type
contacts
[object]
A list of contacts for the entity
contact [required]
string
Contact value
name
string
Contact name
type [required]
string
Contact type.
description
string
Short description of the entity. The UI can leverage the description for display
displayName
string
User friendly name of the entity. The UI can leverage the display name for display
id
string
A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.
inheritFrom
string
The entity reference from which to inherit metadata
links
[object]
A list of links for the entity
name [required]
string
Link name
provider
string
Link provider.
type [required]
string
Link type.
default: other
url [required]
string
Link url
managed
object
A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.
name [required]
string
Unique name given to an entity under the kind/namespace
namespace
string
Namespace is a part of unique identifier. It has a default value of 'default'
owner
The owner of the entity, usually a team
name
string
Team name
tags
[string]
A set of custom tags
spec
object
The definition of Entity V3 Queue Spec object.
lifecycle
string
The lifecycle state of the queue.
tier
string
The importance of the queue
type
string
The type of queue
Option 4
object
Schema for system entities
apiVersion [required]
enum
The schema version of entity type. The field is known as schema-version in the previous version
Allowed enum values: v3
datadog
object
Datadog product integrations for the service entity
events
[object]
Events associations
name
string
The name of the query
query
string
The query to run
logs
[object]
Logs association
name
string
The name of the query
query
string
The query to run
performanceData
object
Performance stats association
tags
[string]
A list of APM entity tags that associates the APM Stats data with the entity
pipelines
object
CI Pipelines association
fingerprints
[string]
A list of CI Fingerprints that associate CI Pipelines with the entity
extensions
object
Custom extensions. This is the free-formed field to send client side metadata. No Datadog features are affected by this field.
integrations
object
A base schema for defining third party integrations
opsgenie
object
An Opsgenie integration schema
region
string
The region for the Opsgenie integration.
serviceURL [required]
string
The service url for the Opsgenie integration.
pagerduty
object
An PagerDuty integration schema
serviceURL [required]
string
The service url for the PagerDuty integration.
kind [required]
enum
The definition of Entity V3 System Kind object.
Allowed enum values: system
metadata [required]
object
The definition of Entity V3 Metadata object.
additionalOwners
[]
The additional owners of the entity, usually a team
name [required]
string
Team name
type
string
Team type
contacts
[object]
A list of contacts for the entity
contact [required]
string
Contact value
name
string
Contact name
type [required]
string
Contact type.
description
string
Short description of the entity. The UI can leverage the description for display
displayName
string
User friendly name of the entity. The UI can leverage the display name for display
id
string
A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.
inheritFrom
string
The entity reference from which to inherit metadata
links
[object]
A list of links for the entity
name [required]
string
Link name
provider
string
Link provider.
type [required]
string
Link type.
default: other
url [required]
string
Link url
managed
object
A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored.
name [required]
string
Unique name given to an entity under the kind/namespace
namespace
string
Namespace is a part of unique identifier. It has a default value of 'default'
owner
The owner of the entity, usually a team
name
string
Team name
tags
[string]
A set of custom tags
spec
object
The definition of Entity V3 System Spec object.
components
[string]
A list of components belongs to the system.
lifecycle
string
The lifecycle state of the component.
tier
string
An entity reference to the owner of the component.
id
string
Entity id.
type
string
Schema type.
meta
object
Entity metadata.
count
int64
Total entities count.
includeCount
int64
Total included data count.
{
"data": [
{
"attributes": {
"apiVersion": "string",
"description": "string",
"displayName": "string",
"kind": "string",
"name": "string",
"namespace": "string",
"owner": "string",
"tags": []
},
"id": "string",
"meta": {
"createdAt": "string",
"ingestionSource": "string",
"modifiedAt": "string",
"origin": "string"
},
"relationships": {
"incidents": {
"data": [
{
"id": "string",
"type": "string"
}
]
},
"oncall": {
"data": [
{
"id": "string",
"type": "string"
}
]
},
"rawSchema": {
"data": {
"id": "string",
"type": "string"
}
},
"relatedEntities": {
"data": [
{
"id": "string",
"type": "string"
}
]
},
"schema": {
"data": {
"id": "string",
"type": "string"
}
}
},
"type": "string"
}
],
"included": [
{
"attributes": {
"schema": {
"apiVersion": "v3",
"datadog": {
"codeLocations": [
{
"paths": [],
"repositoryURL": "string"
}
],
"events": [
{
"name": "string",
"query": "string"
}
],
"logs": [
{
"name": "string",
"query": "string"
}
],
"performanceData": {
"tags": []
},
"pipelines": {
"fingerprints": []
}
},
"extensions": {},
"integrations": {
"opsgenie": {
"region": "string",
"serviceURL": "https://www.opsgenie.com/service/shopping-cart"
},
"pagerduty": {
"serviceURL": "https://www.pagerduty.com/service-directory/Pshopping-cart"
}
},
"kind": "service",
"metadata": {
"additionalOwners": [
{
"name": "",
"type": "string"
}
],
"contacts": [
{
"contact": "https://slack/",
"name": "string",
"type": "slack"
}
],
"description": "string",
"displayName": "string",
"id": "4b163705-23c0-4573-b2fb-f6cea2163fcb",
"inheritFrom": "application:default/myapp",
"links": [
{
"name": "mylink",
"provider": "string",
"type": "link",
"url": "https://mylink"
}
],
"managed": {},
"name": "myService",
"namespace": "default",
"owner": {
"name": "string"
},
"tags": [
"this:tag",
"that:tag"
]
},
"spec": {
"dependsOn": [],
"languages": [],
"lifecycle": "string",
"tier": "string",
"type": "string"
}
}
},
"id": "string",
"type": "string"
}
],
"meta": {
"count": "integer",
"includeCount": "integer"
}
}
Bad Request
API error response.
{
"errors": [
"Bad Request"
]
}
Forbidden
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/catalog/entity" \
-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
{
"apiVersion": "v3",
"datadog": {
"codeLocations": [
{
"paths": []
}
],
"events": [
{}
],
"logs": [
{}
],
"performanceData": {
"tags": []
},
"pipelines": {
"fingerprints": []
}
},
"integrations": {
"opsgenie": {
"serviceURL": "https://www.opsgenie.com/service/shopping-cart"
},
"pagerduty": {
"serviceURL": "https://www.pagerduty.com/service-directory/Pshopping-cart"
}
},
"kind": "service",
"metadata": {
"additionalOwners": [],
"contacts": [
{
"contact": "https://slack/",
"type": "slack"
}
],
"id": "4b163705-23c0-4573-b2fb-f6cea2163fcb",
"inheritFrom": "application:default/myapp",
"links": [
{
"name": "mylink",
"type": "link",
"url": "https://mylink"
}
],
"name": "service-examplesoftwarecatalog",
"tags": [
"this:tag",
"that:tag"
]
},
"spec": {
"dependsOn": [],
"languages": []
}
}
EOF
DELETE https://api.ap1.datadoghq.com/api/v2/catalog/entity/{entity_id}https://api.datadoghq.eu/api/v2/catalog/entity/{entity_id}https://api.ddog-gov.com/api/v2/catalog/entity/{entity_id}https://api.datadoghq.com/api/v2/catalog/entity/{entity_id}https://api.us3.datadoghq.com/api/v2/catalog/entity/{entity_id}https://api.us5.datadoghq.com/api/v2/catalog/entity/{entity_id}
Delete a single entity in Software Catalog.
This endpoint requires the apm_service_catalog_write
authorization scope.
이름
유형
설명
entity_id [required]
string
UUID or Entity Ref
OK
Bad Request
API error response.
{
"errors": [
"Bad Request"
]
}
Forbidden
API error response.
{
"errors": [
"Bad Request"
]
}
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export entity_id="service:myservice"
# Curl command
curl -X DELETE "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/catalog/entity/${entity_id}" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"