v1

latestOpenAPI 3.0.12026-08-061638881007.6 KB
Domains

List domains

get/v1/domains

Query parameters

limitinteger

The number of entities to return.

startingAfterstring uuid

Entity id used to the determine beginning of query results.

sortBy'id' | 'parentId' | 'alias' | 'lock' | 'metadata.createdAt' | 'metadata.lastModifiedAt'

Property name used to sort the query results.

sortOrder'ASC' | 'DESC'

Sort order applied to the query results.

parentIdstring uuid

Filter domains based on given parent/root id.

aliasstring

Return entities with aliases that contains or equals to provided alias.

metadata.createdBystring uuid

Return entities that were created by matching user.

metadata.lastModifiedBystring uuid

Return entities that were last modified by matching user.

metadata.descriptionstring

Return entities with descriptions that contains or equals to provided description.

metadata.customPropertiesstring[]

Return entities that contains provided custom properties.

lockCoreLockStatus[]

Return entities matching given lock status.

Response

countinteger required
currentStartingAfterstring
nextStartingAfterstring