provider Software Catalog GET
/api/v2/catalog/entity @utdk/datadog
/api/v2/catalog/entity Get a list of entities
Get a list of entities from Software Catalog.
- page[offset] query
- Specific offset to use as the beginning of the returned page.
- integer
- page[limit] query
- Maximum number of entities in the response.
- integer
- filter[id] query
- Filter entities by UUID.
- string
- filter[ref] query
- Filter entities by reference
- string
- filter[name] query
- Filter entities by name.
- string
- filter[kind] query
- Filter entities by kind.
- string
- filter[owner] query
- Filter entities by owner.
- string
- filter[relation][type] query
- Filter entities by relation type.
- enum: RelationTypeOwns, RelationTypeOwnedBy, RelationTypeDependsOn, RelationTypeDependencyOf…
- filter[exclude_snapshot] query
- Filter entities by excluding snapshotted entities.
- string
- include query
- Include relationship data.
- enum: schema, raw_schema, oncall, incident…
- includeDiscovered query
- If true, includes discovered services from APM and USM that do not have entity definitions.
- boolean
Try it
Authentication
Configure credentials for Datadog API V2 Collection
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.
Saved automatically to browser storage.
Code snippet
Updates live as you fill in the form above.
TypeScript
import datadog from '@utdk/datadog';
await datadog.listcatalogentity({
"page[offset]": 0,
"page[limit]": 100,
"includeDiscovered": false
})