ITitential
Lifecycle Manager

Search resource instances

Changed on

Searches resource instances.

get/lifecycle-manager/resources/{modelId}/instances

Request

  • Base URL
    https://example.itential.io
  • URL
    https://example.itential.io/lifecycle-manager/resources/{modelId}/instances
  • Auth
    none declared

Path parameters

modelIdstring required

A MongoDB ObjectId

modelId

Query parameters

skipstring

This parameter specifies where to start the returned page of search results.

limitstring

This parameter specifies how many items to return in the search results.

sortstring

This parameter specifies the field to sort the search results over.

order'asc' | 'desc'

This parameter specifies the direction to sort the search results over.

modelNamestring

The name of the resource model

stateNamestring

The name of the current state of the resource instance

_idunknown
namestring

The name of the resource instance

modelIdunknown
createdunknown
createdByunknown
lastUpdatedunknown
lastUpdatedByunknown
instanceDataobject

Custom data associated with the resource instance, stored as a nested object. To filter on a specific value inside it, use dot notation as the property name with equals, in, or starts-with. For example, use instanceData.region. Property names beginning with '$' are not supported.

lastActionobject

Details about the most recently executed action on the resource instance, stored as a nested object. To filter on a specific value inside it, use dot notation as the property name with equals, in, or starts-with. For example, use lastAction.status. Property names beginning with '$' are not supported.

equals

instanceDataobject

Custom data associated with the resource instance, stored as a nested object. To filter on a specific value inside it, use dot notation as the property name with equals, in, or starts-with. For example, use instanceData.region. Property names beginning with '$' are not supported.

in

include-deleted'true' | 'false'

include-deleted

namestring

The name of the resource instance

instanceDataobject

Custom data associated with the resource instance, stored as a nested object. To filter on a specific value inside it, use dot notation as the property name with equals, in, or starts-with. For example, use instanceData.region. Property names beginning with '$' are not supported.

lastActionobject

Details about the most recently executed action on the resource instance, stored as a nested object. To filter on a specific value inside it, use dot notation as the property name with equals, in, or starts-with. For example, use lastAction.status. Property names beginning with '$' are not supported.

starts-with

groupstring

An ID or name of an instance group to filter by

instanceGroups'true' | 'false'

instanceGroups

createdunknown
lastUpdatedunknown

lt

createdunknown
lastUpdatedunknown

lte

createdunknown
lastUpdatedunknown

gt

createdunknown
lastUpdatedunknown

gte

includeLifecycleManagerResourcesModelIdInstancesGetParametersIncludeSchemaItems[]

include

excludeLifecycleManagerResourcesModelIdInstancesGetParametersExcludeSchemaItems[]

exclude

dereferenceunknown

Comma-separated list of foreign key field types to dereference

Response

response

Changes