How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Datadog Entities API

The Entities API from Datadog — 1 operation(s) for entities.

Datadog Entities API is one of 290 APIs that Datadog publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 4 JSON Schema definitions.

Tagged areas include Entities. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, an API reference, and 4 JSON Schemas.

This API exposes 2 operations across 1 path, and defines 83 schemas. It is described by OpenAPI 3.0.0, at version 1.0.

Requests are made against 3 base URLs: https://{subdomain}.{site}, {protocol}://{name}, https://{subdomain}.{site}.

2 operations 1 paths 83 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0
Base URL
https://api.datadoghq.com
Authentication
OAuth 2.0, API Key, API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 4

Datadog Entities API declares 4 security schemes for authenticating requests. It supports OAuth 2.0 (AuthZ) using the authorizationCode flow, exposing 68 scopes. An API key is passed in the header as DD-API-KEY (apiKeyAuth). An API key is passed in the header as DD-APPLICATION-KEY (appKeyAuth). It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • AuthZ — This API uses OAuth 2 with the implicit grant flow.
  • apiKeyAuth — Your Datadog API Key.
  • appKeyAuth — Your Datadog APP Key.

Paths & Operations 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Entities 2
GET
/api/v2/catalog/entity
Datadog Get a List of Entities
ListCatalogEntity 10 params → 200403429
POST
/api/v2/catalog/entity
Datadog Create or Update Entities
UpsertCatalogEntity body → 202400403429

Schemas 83

The contract defines 83 schemas that model the data the API accepts and returns. The most detailed are EntityV3Metadata (12 properties), EntityAttributes (8 properties), EntityV3API (7 properties), EntityV3System (7 properties). Each schema is shown below with its type and property counts.

EntityRaw
string
Entity definition in raw JSON or YAML representation.
EntityToRawSchema
object
Entity to raw schema relationship.
1 property
EntityV3DatadogLogItem
object
Log association item.
2 properties
EntityV3
Entity schema v3.
EntityV3APIVersion
string
The schema version of entity type. The field is known as schema-version in the previous version.
EntityV3DatadogEventItem
object
Events association item.
2 properties
EntityV3DatadogIntegrationOpsgenie
object
An Opsgenie integration schema.
2 properties 1 required
EntityResponseIncludedRelatedOncallEscalations
array
Oncall escalations.
EntityV3APISpecInterfaceDefinition
object
The definition of EntityV3APISpecInterfaceDefinition object.
1 property
EntityV3APISpecInterfaceFileRef
object
The definition of EntityV3APISpecInterfaceFileRef object.
1 property
EntityV3ServiceDatadog
object
Datadog product integrations for the service entity.
5 properties
EntityToRelatedEntities
object
Entity to related entities relationship.
1 property
EntityV3DatastoreKind
string
The definition of Entity V3 Datastore Kind object.
EntityToOncalls
object
Entity to oncalls relationship.
1 property
UpsertCatalogEntityRequest
Create or update entity request.
ListEntityCatalogResponseIncludedItem
List entity response included item.
EntityV3MetadataContactsItems
object
The definition of Entity V3 Metadata Contacts Items object.
3 properties 2 required
EntityResponseIncludedRelatedEntityAttributes
object
Related entity attributes.
4 properties
EntityResponseIncludedRelatedEntity
object
Included related entity.
4 properties
EntityV3Integrations
object
A base schema for defining third-party integrations.
2 properties
EntityV3API
object
Schema for API entities.
7 properties 3 required
EntityResponseIncludedOncall
object
Included oncall.
3 properties
EntityV3SystemSpec
object
The definition of Entity V3 System Spec object.
3 properties
EntityResponseIncludedRawSchemaType
string
Raw schema type.
EntityMeta
object
Entity metadata.
4 properties
EntityV3DatastoreDatadog
object
Datadog product integrations for the datastore entity.
3 properties
EntityResponseIncludedSchemaAttributes
object
Included schema.
1 property
EntityV3Datastore
object
Schema for datastore entities.
7 properties 3 required
EntityV3DatadogPerformance
object
Performance stats association.
1 property
EntityToIncidents
object
Entity to incidents relationship.
1 property
EntityResponseIncludedRelatedOncallAttributes
object
Included related oncall attributes.
2 properties
EntityResponseData
array
List of entity data.
EntityV3QueueDatadog
object
Datadog product integrations for the datastore entity.
3 properties
EntityResponseMeta
object
Entity metadata.
2 properties
EntityResponseIncludedRawSchema
object
Included raw schema.
3 properties
EntityV3QueueSpec
object
The definition of Entity V3 Queue Spec object.
4 properties
RelationshipArray
array
Relationships.
EntityResponseIncludedRelatedIncidentAttributes
object
Incident attributes.
5 properties
EntityResponseIncludedSchema
object
Included detail entity schema.
3 properties
EntityAttributes
object
Entity attributes.
8 properties
EntityV3APIKind
string
The definition of Entity V3 API Kind object.
EntityV3DatadogLogs
array
Logs association.
EntityV3APIDatadog
object
Datadog product integrations for the API entity.
5 properties
EntityResponseIncludedIncident
object
Included incident.
3 properties
ListEntityCatalogResponseIncluded
array
List entity response included.
APIErrorResponse
object
API error response.
1 property 1 required
UpsertCatalogEntityResponseIncluded
array
Upsert entity response included.
ListEntityCatalogResponse
object
List entity response.
4 properties
EntityV3ServiceSpec
object
The definition of Entity V3 Service Spec object.
6 properties
RelationType
string
Supported relation types.
EntityV3Service
object
Schema for service entities.
7 properties 3 required
EntityResponseIncludedSchemaType
string
Schema type.
EntityV3Queue
object
Schema for queue entities.
7 properties 3 required
EntityV3MetadataAdditionalOwnersItems
object
The definition of Entity V3 Metadata Additional Owners Items object.
2 properties 1 required
EntityV3APISpecInterface
The API definition.
EntityV3SystemDatadog
object
Datadog product integrations for the service entity.
4 properties
EntityV3DatadogCodeLocationItem
object
Code location item.
2 properties
EntityResponseIncludedRelatedEntityMeta
object
Included related entity meta.
4 properties
EntityResponseIncludedRelatedEntityType
string
Related entity.
EntityRelationships
object
Entity relationships.
5 properties
IncludeType
string
Supported include types.
EntityToSchema
object
Entity to detail schema relationship.
1 property
EntityV3DatadogPipelines
object
CI Pipelines association.
1 property
EntityV3DatadogEvents
array
Events associations.
EntityV3System
object
Schema for system entities.
7 properties 3 required
RelationshipItem
object
Relationship entry.
2 properties
EntityResponseIncludedRelatedOncallEscalationItem
object
Oncall escalation.
3 properties
EntityV3MetadataLinksItems
object
The definition of Entity V3 Metadata Links Items object.
4 properties 3 required
EntityV3DatadogCodeLocations
array
Schema for mapping source code locations to an entity.
EntityResponseIncludedIncidentType
string
Incident description.
EntityV3SystemKind
string
The definition of Entity V3 System Kind object.
UpsertCatalogEntityResponse
object
Upsert entity response.
3 properties
EntityV3ServiceKind
string
The definition of Entity V3 Service Kind object.
EntityResponseIncludedOncallType
string
Oncall type.
EntityV3APISpec
object
The definition of Entity V3 API Spec object.
5 properties
UpsertCatalogEntityResponseIncludedItem
Upsert entity response included item.
EntityV3QueueKind
string
The definition of Entity V3 Queue Kind object.
EntityV3DatadogIntegrationPagerduty
object
A PagerDuty integration schema.
1 property 1 required
EntityResponseIncludedRawSchemaAttributes
object
Included raw schema attributes.
1 property
EntityV3Metadata
object
The definition of Entity V3 Metadata object.
12 properties 1 required
EntityV3DatastoreSpec
object
The definition of Entity V3 Datastore Spec object.
4 properties
EntityData
object
Entity data.
5 properties
ListEntityCatalogResponseLinks
object
List entity response links.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

datadog-entities-api-openapi.yml Raw ↑

Other APIs Datadog publishes across the network.

Datadog Dashboards API
Datadog Synthetics API
Datadog Service Level Objectives API
Datadog Security Monitoring API
Datadog Service Definition API
Datadog Software Catalog API
Datadog Users API
Datadog Roles API
Datadog Key Management API
Datadog Organizations API
Datadog Downtimes API
Datadog RUM API
Where this information came from

This is an independent, third-party profile of Datadog Entities API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.