v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Service Definition

Get a single service definition

Get a single service definition from the Datadog Service Catalog.

get/api/v2/services/definitions/{service_name}

Path parameters

service_namestring required

Example:my-service

The name of the service.

Query parameters

schema_version'v1' | 'v2' | 'v2.1' | 'v2.2'

Schema versions

The schema version desired in the response.

Response

Example response

{
  "data": {
    "attributes": {
      "schema": {
        "contact": {
          "email": "contact@datadoghq.com",
          "slack": "https://yourcompany.slack.com/archives/channel123"
        },
        "extensions": {
          "myorg/extension": "extensionValue"
        },
        "external-resources": [
          {
            "name": "Runbook",
            "type": "runbook",
            "url": "https://my-runbook"
          }
        ],
        "info": {
          "dd-service": "myservice",
          "description": "A shopping cart service",
          "display-name": "My Service",
          "service-tier": "Tier 1"
        },
        "integrations": {
          "pagerduty": "https://my-org.pagerduty.com/service-directory/PMyService"
        },
        "org": {
          "application": "E-Commerce",
          "team": "my-team"
        },
        "schema-version": "v1",
        "tags": [
          "my:tag",
          "service:tag"
        ]
      }
    }
  }
}