Skip to main content

InstancesFilter

Filter which instances to return.

All filters are combined with AND. For example, setting both status and ociRepoName returns only instances that match both criteria.

input InstancesFilter {
projectId: IdFilter
environmentId: IdFilter
status: InstanceStatusFilter
ociRepoName: OciRepoNameFilter
bundleId: BundleIdFilter
paramDimension: [ParamDimensionFilter!]
attributes: [AttributeFilter!]
}

Fields

InstancesFilter.projectId ● IdFilter input {#project-id}

Match by the owning project's ID.

InstancesFilter.environmentId ● IdFilter input {#environment-id}

Match by the environment's ID.

InstancesFilter.status ● InstanceStatusFilter input {#status}

Match by lifecycle status (e.g., PROVISIONED, FAILED).

InstancesFilter.ociRepoName ● OciRepoNameFilter input {#oci-repo-name}

Match by the OCI repository name of the underlying bundle. Returns every version published to the repo.

InstancesFilter.bundleId ● BundleIdFilter input {#bundle-id}

Match by a specific bundle version (name@version) or release channel (name@~1, name@latest). Use ociRepoName instead to match every version of a bundle.

InstancesFilter.paramDimension ● [ParamDimensionFilter!] list input {#param-dimension}

Filter by configuration parameter values. Each entry targets a specific param field; multiple entries are combined with AND.

InstancesFilter.attributes ● [AttributeFilter!] list input {#attributes}

Match by effective attributes — the instance's own attributes plus those inherited from its component, environment, and project. Each entry targets one attribute key; multiple entries are combined with AND.

Member Of

instances query