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 APM Service Definition API

API to create, update, retrieve and delete service definitions.Note: Service Catalog [v3.0 schema](https://docs.datadoghq.com/service_catalog/service_definitions/v3-0/) has new API endpoints documented under [Software Catalog](https://docs.datadoghq.com/api/latest/software-catalog/). Use the following Service Definition endpoints for v2.2 and earlier.

Datadog APM Service Definition API is one of 8 APIs that Datadog APM publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Service Definition. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 4 operations across 2 paths, and defines 62 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

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

4 operations 2 paths 62 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.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 APM Service Definition API declares 4 security schemes for authenticating requests. It supports OAuth 2.0 (AuthZ) using the authorizationCode flow, exposing 96 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 4

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

Service Definition 4

API to create, update, retrieve and delete service definitions. Note: Service Catalog v3.0 schema has new API endpoints documented under Software Catalog. Use the following Servic…

GET
/api/v2/services/definitions
Get all service definitions
ListServiceDefinitions 3 params → 200403429
POST
/api/v2/services/definitions
Create or update service definition
CreateOrUpdateServiceDefinitions body → 200400403409429
DELETE
/api/v2/services/definitions/{service_name}
Delete a single service definition
DeleteServiceDefinition 1 param → 204400403404429
GET
/api/v2/services/definitions/{service_name}
Get a single service definition
GetServiceDefinition 2 params → 200400403404409429

Schemas 62

The contract defines 62 schemas that model the data the API accepts and returns. The most detailed are ServiceDefinitionV2Dot2 (15 properties), ServiceDefinitionV2Dot1 (12 properties), ServiceDefinitionV2 (11 properties), ServiceDefinitionV1 (8 properties). Each schema is shown below with its type and property counts.

ServiceDefinitionV2MSTeamsType
string
Contact type.
ServiceDefinitionGetResponse
object
Get service definition response.
1 property
ServiceDefinitionV2Dot1MSTeams
object
Service owner's Microsoft Teams.
3 properties 2 required
ServiceDefinitionV2Dot1LinkType
string
Link type.
ServiceDefinitionV2OpsgenieRegion
string
Opsgenie instance region.
ServiceDefinitionV1Version
string
Schema version being used.
ServiceDefinitionV2Version
string
Schema version being used.
ServiceDefinitionV2Dot1MSTeamsType
string
Contact type.
ServiceDefinitionV2Link
object
Service's external links.
3 properties 3 required
ServiceDefinitionV1Resource
object
Service's external links.
3 properties 3 required
ServiceDefinitionV2Dot1Link
object
Service's external links.
4 properties 3 required
ServiceDefinitionV1Pagerduty
string
PagerDuty service URL for the service.
ServiceDefinitionV2Dot2Integrations
object
Third party integrations that Datadog supports.
2 properties
ServiceDefinitionsCreateRequest
Create service definitions request.
ServiceDefinitionV2Opsgenie
object
Opsgenie integration for the service.
2 properties 1 required
ServiceDefinitionCreateResponse
object
Create service definitions response.
1 property
ServiceDefinitionV2Dot1Version
string
Schema version being used.
ServiceDefinitionV2Dot2Version
string
Schema version being used.
ServiceDefinitionV2Dot1Contact
Service owner's contacts information.
ServiceDefinitionRaw
string
Service Definition in raw JSON/YAML representation.
ServiceDefinitionV2Dot1SlackType
string
Contact type.
ServiceDefinitionDataAttributes
object
Service definition attributes.
2 properties
ServiceDefinitionV2Dot1OpsgenieRegion
string
Opsgenie instance region.
ServiceDefinitionV2Dot2Type
string
The type of service.
ServiceDefinitionV2Dot2Contact
object
Service owner's contacts information.
3 properties 2 required
ServiceDefinitionV2MSTeams
object
Service owner's Microsoft Teams.
3 properties 2 required
ServiceDefinitionV2Dot2OpsgenieRegion
string
Opsgenie instance region.
ServiceDefinitionV1
object
Deprecated - Service definition V1 for providing additional service metadata and integrations.
8 properties 2 required
ServiceDefinitionSchemaVersions
string
Schema versions
ServiceDefinitionV1ResourceType
string
Link type.
ServiceDefinitionV2Dot1Slack
object
Service owner's Slack channel.
3 properties 2 required
ServiceDefinitionV2Dot1Opsgenie
object
Opsgenie integration for the service.
2 properties 1 required
ServiceDefinitionV2Dot2Opsgenie
object
Opsgenie integration for the service.
2 properties 1 required
ServiceDefinitionSchema
Service definition schema.
ServiceDefinitionV2Pagerduty
string
PagerDuty service URL for the service.
ServiceDefinitionV1Integrations
object
Third party integrations that Datadog supports.
1 property
ServiceDefinitionV2
object
Service definition V2 for providing service metadata and integrations.
11 properties 2 required
ServiceDefinitionV2Repo
object
Service code repositories.
3 properties 2 required
ServiceDefinitionV2EmailType
string
Contact type.
ServiceDefinitionV2Dot1
object
Service definition v2.1 for providing service metadata and integrations.
12 properties 2 required
ServiceDefinitionV2Dot1Pagerduty
object
PagerDuty integration for the service.
1 property
ServiceDefinitionMeta
object
Metadata about a service definition.
7 properties
ServiceDefinitionsListResponse
object
Create service definitions response.
1 property
ServiceDefinitionV1Info
object
Basic information about a service.
4 properties 1 required
ServiceDefinitionV1Contact
object
Contact information about the service.
2 properties
ServiceDefinitionV2Contact
Service owner's contacts information.
ServiceDefinitionV2Dot1Integrations
object
Third party integrations that Datadog supports.
2 properties
ServiceDefinitionV2Dot1EmailType
string
Contact type.
APIErrorResponse
object
API error response.
1 property 1 required
ServiceDefinitionV2Dot1Email
object
Service owner's email.
3 properties 2 required
ServiceDefinitionV2Slack
object
Service owner's Slack channel.
3 properties 2 required
ServiceDefinitionData
object
Service definition data.
3 properties
ServiceDefinitionV2SlackType
string
Contact type.
ServiceDefinitionV2Integrations
object
Third party integrations that Datadog supports.
2 properties
ServiceDefinitionV1Org
object
Org related information about the service.
2 properties
ServiceDefinitionV2Dot2
object
Service definition v2.2 for providing service metadata and integrations.
15 properties 2 required
ServiceDefinitionV2Dot2Link
object
Service's external links.
4 properties 3 required
ServiceDefinitionV2Doc
object
Service documents.
3 properties 2 required
ServiceDefinitionV2LinkType
string
Link type.
ServiceDefinitionV2Email
object
Service owner's email.
3 properties 2 required
ServiceDefinitionV2Dot2Pagerduty
object
PagerDuty integration for the service.
1 property
ServiceDefinitionMetaWarnings
object
Schema validation warnings.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

datadog-apm-service-definition-api-openapi.yml Raw ↑

Other APIs Datadog APM publishes across the network.

Datadog APM Spans API
Datadog APM Spans Metrics API
Datadog MCP Server
Datadog APM API
Datadog APM Retention Filters API
Datadog APM Service Level Objective Corrections API
Datadog APM Service Level Objectives API
Where this information came from

This is an independent, third-party profile of Datadog APM Service Definition 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.