Sign in

v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB
Software Catalog

Get a list of entities

Get a list of entities from Software Catalog.

get/api/v2/catalog/entity

Query parameters

page[offset]integer

Specific offset to use as the beginning of the returned page.

page[limit]integer

Maximum number of entities in the response.

filter[id]string

Filter entities by UUID.

filter[ref]string

Filter entities by reference

filter[name]string

Filter entities by name.

filter[kind]string

Filter entities by kind.

filter[owner]string

Filter entities by owner.

filter[relation][type]'RelationTypeOwns' | 'RelationTypeOwnedBy' | 'RelationTypeDependsOn' | 'RelationTypeDependencyOf' | 'RelationTypePartsOf' | 'RelationTypeHasPart' | 'RelationTypeOtherOwns' | 'RelationTypeOtherOwnedBy' | 'RelationTypeImplementedBy' | 'RelationTypeImplements'

Supported relation types.

Filter entities by relation type.

filter[exclude_snapshot]string

Filter entities by excluding snapshotted entities.

include'schema' | 'raw_schema' | 'oncall' | 'incident' | 'relation'

Supported include types.

Include relationship data.

includeDiscoveredboolean

If true, includes discovered services from APM and USM that do not have entity definitions.

Response

OK