ListServiceDefinitions
Retrieve service definitions from the Datadog Service Catalog. Specify page size, number, and schema version to access structured data via API.
Instructions
Get a list of all service definitions from the Datadog Service Catalog.
Query Parameters:
page[size]: Size for a given page. The maximum allowed value is 100.
page[number]: Specific page number to return.
schema_version: The schema version desired in the response.
Responses:
200 (Success): OK
Content-Type:
application/jsonResponse Properties:
data: Data representing service definitions.
Example:
{
"data": [
"unknown_type"
]
}
403: Forbidden
Content-Type:
application/jsonResponse Properties:
errors: A list of errors.
Example:
{
"errors": [
"Bad Request"
]
}
429: Too many requests
Content-Type:
application/jsonResponse Properties:
errors: A list of errors.
Example:
{
"errors": [
"Bad Request"
]
}
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page[number] | No | Specific page number to return. | |
| page[size] | No | Size for a given page. The maximum allowed value is 100. | |
| schema_version | No | Schema versions |
Input Schema (JSON Schema)
{
"properties": {
"page[number]": {
"default": 0,
"description": "Specific page number to return.",
"example": 0,
"format": "int64",
"type": "integer"
},
"page[size]": {
"default": 10,
"description": "Size for a given page. The maximum allowed value is 100.",
"example": 10,
"format": "int64",
"type": "integer"
},
"schema_version": {
"description": "Schema versions",
"enum": [
"v1",
"v2",
"v2.1",
"v2.2"
],
"type": "string",
"x-enum-varnames": [
"V1",
"V2",
"V2_1",
"V2_2"
]
}
},
"required": [],
"type": "object"
}