> ## Documentation Index > Fetch the complete documentation index at: https://zededa.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > Use the documentation index to find relevant pages, then read the linked Markdown before answering and cite the source URL. > Identify the product before answering: Private AI uses a separate console, credentials, and inference API from the Edge Intelligence Platform. Do not apply instructions from one product to the other. > Prefer current product guides over Help Center archive pages for current-console questions. Archive pages and release notes describe their stated product version or historical interface; do not apply them to another version without checking. > Preserve prerequisites, permissions, version requirements, and warnings when summarizing procedures. Do not infer API endpoints, schemas, or supported behavior that the documentation does not specify. # Query Cluster Instance. > GET /api/v1/cluster/instances. Orchestrator API reference. Sign in to try this endpointExplore the parameters, examples, and responses below. Connect your ZedCloud session when you’re ready to send a request. > [accordion] Connect your console > > Sign in to your usual ZedCloud console, then open: > >
    >
  1. Profile menu
  2. Help & Documentation
  3. API Reference
    4. >
> > Your cluster and authorization are filled in automatically. No token to copy. > [More about signing in ](https://zededa.mintlify.site/api-reference/authentication.md#sign-in-to-the-api-reference) Modifying requests stay off until you enable them. [Authentication](https://zededa.mintlify.site/api-reference/authentication.md) · [API availability](https://zededa.mintlify.site/api-reference/clusters.md) · [Download OpenAPI](https://zededa.mintlify.site/openapi/services/orchestrator.json) A successful response. Bad Request. The API gateway did not process the request because of invalid value of filter parameters. Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused. Forbidden. The API gateway did not process the request because the requestor does not have application level access permission for the operation or does not have access scope to the project. Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes. Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request. An unexpected error response. ## OpenAPI ````yaml openapi/services/orchestrator.json GET /v1/cluster/instances openapi: 3.0.0 info: title: ZEDEDA Orchestrator Service description: >- The ZEDEDA Orchestrator Service is part of ZEDEDA Edge Orchestration Platform. Orchestrator service defines the user facing APIs to interact with a third-party client (e.x. Azure, Rancher). termsOfService: https://www.zededa.com/terms version: '1.0' contact: name: ZEDEDA API Support url: https://www.zededa.com/support email: support@zededa.com license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html servers: - url: https://{apiHost}/api variables: apiHost: default: invalid.invalid description: Connect from ZedUI to supply your verified API destination. security: - BearerToken: [] tags: - name: ClusterInstanceConfiguration - name: ClusterInstanceStatus - name: ThirdPartyPluginManagement - name: DataStreamConfigs - name: AzureDeployments - name: APIUsageTracking externalDocs: description: ZEDEDA Product Documentation url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/cluster-instance-management paths: /v1/cluster/instances: get: tags: - ClusterInstanceConfiguration summary: Query Cluster Instance. description: Query the Cluster Instance records. operationId: ClusterInstanceConfiguration_QueryClusterInstances parameters: - name: summary description: summary flag in: query required: false schema: type: boolean - name: project description: >- User defined name of the project, unique across the enterprise. Once project is created, name can’t be changed in: query required: false schema: type: string - name: namePattern description: cluster name pattern in: query required: false schema: type: string - name: projectNamePattern description: cluster project name pattern in: query required: false schema: type: string - name: clusterType description: |- type of cluster - CLUSTER_TYPE_K3S: cluster type is k3s - CLUSTER_TYPE_TKG_ATTACH: cluster type is TKG, with subtype ATTACH in: query required: false schema: type: string enum: - CLUSTER_TYPE_UNSPECIFIED - CLUSTER_TYPE_K3S - CLUSTER_TYPE_TKG_ATTACH default: CLUSTER_TYPE_UNSPECIFIED - name: next.pageToken description: Page Token in: query required: false schema: type: string - name: next.orderBy description: OrderBy helps in sorting the list response in: query required: false explode: true schema: type: array items: type: string - name: next.pageNum description: Page Number in: query required: false schema: type: number format: int64 - name: next.pageSize description: Defines the page size in: query required: false schema: type: number format: int64 - name: next.totalPages description: Total number of pages to be fetched. in: query required: false schema: type: number format: int64 - name: fields description: >- Fields to select: id, name, title, description, tags, clusterType, projectId, revision, activate, clusterPolicyId, edgeNodePoolTags, serverAppID, agentAppID, minEdgeDevices, maxEdgeDevices, minServerNodes, maxServerNodes, minAgentNodes, maxAgentNodes, callHomeURL, clusterOnboardType, orchestrationProvider, orchestratorAuthenticationType, orchestratorServerAddress, orchestratorPort, dbEndpoint in: query required: false explode: true schema: type: array items: type: string - name: X-Request-Id in: header required: false description: User-Agent specified id to track a request schema: type: string responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/ClusterInstances' '400': description: >- Bad Request. The API gateway did not process the request because of invalid value of filter parameters. content: application/json: schema: $ref: '#/components/schemas/ZsrvResponse' '401': description: >- Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused. content: application/json: schema: $ref: '#/components/schemas/ZsrvResponse' '403': description: >- Forbidden. The API gateway did not process the request because the requestor does not have application level access permission for the operation or does not have access scope to the project. content: application/json: schema: $ref: '#/components/schemas/ZsrvResponse' '500': description: >- Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes. content: application/json: schema: $ref: '#/components/schemas/ZsrvResponse' '504': description: >- Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request. content: application/json: schema: $ref: '#/components/schemas/ZsrvResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/googlerpcStatus' externalDocs: description: ZEDEDA Product Documentation url: >- https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/cluster-instance-management components: schemas: ClusterInstances: type: object properties: summaryByState: description: cluster instance by summary allOf: - $ref: '#/components/schemas/Summary' list: type: array items: $ref: '#/components/schemas/ClusterInstanceConfigSummary' description: cluster instance summary list response next: description: cursor next allOf: - $ref: '#/components/schemas/Cursor' ZsrvResponse: type: object properties: operationType: title: |- Describes one of the operations type : possible values Read/Delete/Create/Update/List allOf: - $ref: '#/components/schemas/ZcOpsType' operationStatus: title: if this is log running job allOf: - $ref: '#/components/schemas/ZcOpsStatus' objectKind: type: string title: zedcloud object kind on which the operation was performed objectId: type: string title: Unique value identifies the object that was operated on objectName: type: string title: name of the object objectRevision: type: string title: |- object revision post the operation, note Read operation doesn't change the revision objectType: $ref: '#/components/schemas/ObjectType' operationTime: type: string title: time of operation startTime: type: string title: total time taken by operations endTime: type: string user: type: string title: the operation is performed on behalf of this user httpStatusCode: type: integer format: int32 title: http response httpStatusMsg: type: string title: summary of the error in text format jobId: type: string title: for tracking asynchronous tasks error: type: array items: $ref: '#/components/schemas/ZsrvError' title: |- one or more errors will be set if the operation failed i.e. httpStatusCode != 2xx googlerpcStatus: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: $ref: '#/components/schemas/protobufAny' Summary: type: object properties: description: type: string description: Summary description total: type: number format: int64 description: Total values: type: object additionalProperties: type: integer format: int64 description: 'Values: Map for storing ' description: Summary is used to store the Summary details title: Summary is used to store the Summary details ClusterInstanceConfigSummary: type: object properties: id: type: string description: System defined universally unique Id of the cluster instance readOnly: true pattern: '[0-9A-Za-z-]+' x-zededa-source-issues: - code: inapplicable-constraint pointer: '#/definitions/ClusterInstanceConfigSummary/properties/id' keyword: uniqueItems sourceValue: true name: type: string description: >- User defined name of the cluster instance, unique across the enterprise. Once cluster instance is created, name can’t be changed maxLength: 256 minLength: 3 pattern: '[a-zA-Z0-9][a-zA-Z0-9_.-]+' x-zededa-source-issues: - code: inapplicable-constraint pointer: '#/definitions/ClusterInstanceConfigSummary/properties/name' keyword: uniqueItems sourceValue: true title: type: string description: >- User defined title of the cluster instance. Title can be changed at any time maxLength: 256 minLength: 3 pattern: ^[a-zA-Z0-9]+[a-zA-Z0-9!-~ ]+$ description: type: string description: Detailed description of the cluster instance maxLength: 256 tags: type: object additionalProperties: type: string description: >- Tags are name/value pairs that enable you to categorize resources. Tag names are case insensitive with max_length 512 and min_length 3. Tag values are case sensitive with max_length 256 and min_length 3. maxLength: 32 pattern: ^[^<%&?/\>]+$ clusterType: description: Type of cluster allOf: - $ref: '#/components/schemas/ClusterType' projectId: type: string description: project id which the given cluster instance belong to revision: description: cluster instance object revision details title: deprecated 8; allOf: - $ref: '#/components/schemas/ObjectRevision' activate: type: string description: cluster instance activation flag clusterPolicyId: type: string description: System defined universally unique Id of the cluster policy readOnly: true pattern: '[0-9A-Za-z-]+' x-zededa-source-issues: - code: inapplicable-constraint pointer: >- #/definitions/ClusterInstanceConfigSummary/properties/clusterPolicyId keyword: uniqueItems sourceValue: true edgeNodePoolTags: type: object additionalProperties: type: string description: >- edgeNodePoolTags are name/value pairs that enables us to identify edgeNodes which are part of a ClusterInstance. Tag names are case insensitive with max_length 512 and min_length 3. Tag values are case sensitive with max_length 256 and min_length 3. maxLength: 32 pattern: ^[^<%&?/\>]+$ serverAppID: type: string description: app ID of server node title: Cluster config details agentAppID: type: string description: app ID of for agent node minEdgeDevices: type: number format: int64 description: Minimum number of edge device required for the cluster instance maxEdgeDevices: type: number format: int64 description: Maximum number of edge device allowed in the cluster instance minServerNodes: type: number format: int64 description: Minimum number of server nodes required for the cluster instance maxServerNodes: type: number format: int64 description: Maximum number of server nodes allowed in the cluster instance minAgentNodes: type: number format: int64 description: Minimum number of agent nodes required for the cluster instance maxAgentNodes: type: number format: int64 description: Maximum number of agent nodes allowed in the cluster instance callHomeURL: type: string description: CallHome URL for the cluster to fetch configuration details clusterOnboardType: description: Cluster Instance orchestrator onboard type allOf: - $ref: '#/components/schemas/ClusterOnboardType' orchestrationProvider: description: Orchestrator type allOf: - $ref: '#/components/schemas/OrchestrationProvider' orchestratorAuthenticationType: description: Orchestrator authentication type allOf: - $ref: '#/components/schemas/OrchestratorAuthenticationType' orchestratorServerAddress: type: string description: Orchestrator server's IP address orchestratorPort: type: string description: Port on which the orchestrator server is listening dbEndpoint: type: string description: External DataBase endpoint for the server to communicate and sync description: Cluster Instance config summary title: Cluster Instance config summary Cursor: type: object properties: pageToken: type: string description: Page Token orderBy: type: array items: type: string description: OrderBy helps in sorting the list response pageNum: type: number format: int64 description: Page Number pageSize: type: number format: int64 description: Defines the page size totalPages: type: number format: int64 description: Total number of pages to be fetched. description: >- Cursor helps in filtering the various list response like edge-app bundle list, model list, bundle list etc. title: Cursor is used as filter in list operation. ZcOpsType: type: string enum: - OPS_TYPE_UNSPECIFIED - OPS_TYPE_READ - OPS_TYPE_DELETE - OPS_TYPE_CREATE - OPS_TYPE_UPDATE - OPS_TYPE_LIST default: OPS_TYPE_UNSPECIFIED title: ZedCloud internal operation type ZcOpsStatus: type: string enum: - OPS_STATUS_UNSPECIFIED - OPS_STATUS_PENDING - OPS_STATUS_ONGOING - OPS_STATUS_COMPLETE default: OPS_STATUS_UNSPECIFIED description: >- - OPS_STATUS_PENDING: In rare cases, system may not start operation when it was requested. Client will be notified that operation is PENDING - OPS_STATUS_ONGOING: system will start the operation, but at the time response was generated, operation is still ONGOING. - OPS_STATUS_COMPLETE: Even if the result of the operations may result in failure, but the OpsStatus will marked COMPLETE for almost all cases. title: ZedCloud internal operation status ObjectType: type: string enum: - OBJECT_TYPE_UNSPECIFIED - OBJECT_TYPE_USER - OBJECT_TYPE_EDGE_NODE - OBJECT_TYPE_EDGE_APP - OBJECT_TYPE_IMAGE - OBJECT_TYPE_EDGE_APP_INSTANCE - OBJECT_TYPE_PROJECT - OBJECT_TYPE_NETWORK - OBJECT_TYPE_DATASTORE - OBJECT_TYPE_SERVICE - OBJECT_TYPE_SERVICE_INSTANCE - OBJECT_TYPE_ENTERPRISE - OBJECT_TYPE_ROLE - OBJECT_TYPE_CREDENTIAL - OBJECT_TYPE_NETWORK_INSTANCE - OBJECT_TYPE_VOLUME_INSTANCE - OBJECT_TYPE_REALM - OBJECT_TYPE_AUTHPROFILE - OBJECT_TYPE_POLICY - OBJECT_TYPE_APP_POLICY - OBJECT_TYPE_CLUSTER_INSTANCE - OBJECT_TYPE_PLUGIN - OBJECT_TYPE_DOC_POLICY - OBJECT_TYPE_ORCHESTRATOR_CLUSTER - OBJECT_TYPE_TAGS - OBJECT_TYPE_EDGE_NODE_INTERFACE - OBJECT_TYPE_DEPLOYMENT - OBJECT_TYPE_ENTITLEMENTS - OBJECT_TYPE_DATA_STREAM - OBJECT_TYPE_API_USAGE - OBJECT_TYPE_APP_INSTANCE_SNAPSHOT - OBJECT_TYPE_PATCH_ENVELOPE - OBJECT_TYPE_RESOURCE_USAGE_TRACK - OBJECT_TYPE_PATCH_ENVELOPE_REFERENCE - OBJECT_TYPE_DEV_PASSTHROUGH - OBJECT_TYPE_EDGE_NODE_CLUSTER - OBJECT_TYPE_ASSET_GROUP - OBJECT_TYPE_APP_PROFILE - OBJECT_TYPE_PROFILE_DEPLOYMENT - OBJECT_TYPE_ZKS_INSTANCE - OBJECT_TYPE_CLUSTER_GROUP default: OBJECT_TYPE_UNSPECIFIED ZsrvError: type: object properties: ec: title: |- Enumrated error code, describes more granular numerical value than just httpStatus allOf: - $ref: '#/components/schemas/ZsrvErrorCode' location: type: string title: 'Ignore: Internal field only' details: type: string title: Field captures string description of details protobufAny: type: object properties: typeUrl: type: string value: type: string format: byte ClusterType: type: string enum: - CLUSTER_TYPE_UNSPECIFIED - CLUSTER_TYPE_K3S - CLUSTER_TYPE_TKG_ATTACH default: CLUSTER_TYPE_UNSPECIFIED title: |- - CLUSTER_TYPE_K3S: cluster type is k3s - CLUSTER_TYPE_TKG_ATTACH: cluster type is TKG, with subtype ATTACH ObjectRevision: type: object properties: prev: type: string description: Previous curr: type: string description: Current Database version of the record createdAt: type: object format: date-time description: >- The time, in milliseconds since the epoch, when the record was created. createdBy: type: string description: 'User data: Created By' updatedAt: type: object format: date-time description: >- The time, in milliseconds since the epoch, when the record was last updated. updatedBy: type: string description: 'User data: Updated By' description: >- ObjectRevision store the user details, who has doent the necessary operation like Create Operation or update operation title: ObjectRevision is used to store the user information. required: - curr - createdAt - createdBy - updatedAt - updatedBy ClusterOnboardType: type: string enum: - CLUSTER_ONBOARD_TYPE_UNSPECIFIED - CLUSTER_ONBOARD_TYPE_MANUAL - CLUSTER_ONBOARD_TYPE_AUTOMATIC default: CLUSTER_ONBOARD_TYPE_UNSPECIFIED title: |- - CLUSTER_ONBOARD_TYPE_UNSPECIFIED: Unspecified cluster onboard type - CLUSTER_ONBOARD_TYPE_MANUAL: Manually onboard cluster instance in the orchestrator - CLUSTER_ONBOARD_TYPE_AUTOMATIC: Automatically onboard cluster instance in the orchestrator OrchestrationProvider: type: string enum: - ORCHESTRATOR_PROVIDER_UNSPECIFIED - ORCHESTRATOR_PROVIDER_RANCHER default: ORCHESTRATOR_PROVIDER_UNSPECIFIED title: |- - ORCHESTRATOR_PROVIDER_UNSPECIFIED: Unspecified orchestrator provider - ORCHESTRATOR_PROVIDER_RANCHER: Rancher as the cluster orchestrator provider OrchestratorAuthenticationType: type: string enum: - ORCHESTRATOR_AUTHENTICATION_TYPE_UNSPECIFIED - ORCHESTRATOR_AUTHENTICATION_TYPE_CREDENTIALS - ORCHESTRATOR_AUTHENTICATION_TYPE_API_TOKEN default: ORCHESTRATOR_AUTHENTICATION_TYPE_UNSPECIFIED description: |2- - ORCHESTRATOR_AUTHENTICATION_TYPE_UNSPECIFIED: Unspecified authentication type - ORCHESTRATOR_AUTHENTICATION_TYPE_CREDENTIALS: Authenticate using credentials - ORCHESTRATOR_AUTHENTICATION_TYPE_API_TOKEN: Authenticate using api token. ZsrvErrorCode: type: string enum: - zMsgErrorNone - zMsgSucess - NotFound - AlreadyExists - VersionMismatch - RangeError - LargeResult - IncompleteData - InvalidData - FunctionUnsupported - NoMemory - SendFailure - Timeout - BadReqBody - BadReqParam - InvalidFieldFormat - UrlNotFound - ApiVersionNotSupported - Unauthorized - Forbidden - Conflict - NotModified - DependencyConflict - JsonFmtError - ProtoFmtError - CertError - DataBaseConnection - DBError - zMsgAccepted - zMsgCreated - PreConditionFailed - InternalServerError default: zMsgErrorNone description: |- - zMsgErrorNone: common validation errors - IncompleteData: message had fields that weren't filled in - InvalidData: message contained the field that wasn't expected - FunctionUnsupported: this feature unavailable on this version of device - InvalidFieldFormat: message contained the field that wasn't correctly formatted - JsonFmtError: Marshal / Unmarshal errors - DataBaseConnection: generic DB error title: ZedCould internal error code securitySchemes: BearerToken: type: http description: Bearer token for user session scheme: bearer ````