> ## 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 datastores > GET /api/v1/datastores. Storage 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/storage.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 edge-node 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/storage.json GET /v1/datastores openapi: 3.0.0 info: title: ZEDEDA Storage Service description: >- The ZEDEDA Storage Service is helper service to ZEDEDA Edge Application Service. This service allows customers to store edge application images and other artifacts (e.g. logo, screenshot, license, developer agreement etc.) in Datastores. This service allows customers to select datastores -- ZEDEDA owned and operated Datastores in public cloud (AWS S3 or Azure Blobstorage) -- Public Datastores (e.g. Docker Hub, Azure Container registry etc.) -- Customer owned and operated Datastores in public cloud (AWS S3 or Azure Blobstorage) -- Customer owned and operated Datastores in their own enterprise Data Centre This service allows binary files of the images and artifacts to be uploaded in one of the above Datastores, artifacts to be downloaded from datastores. Edge nodes will download edge application image binary files from these datastores 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: ImageConfiguration - name: DatastoreConfiguration - name: ArtifactManager - name: VolumeInstanceConfiguration - name: VolumeInstanceStatus externalDocs: description: ZEDEDA Product Documentation url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/storage paths: /v1/datastores: get: tags: - DatastoreConfiguration summary: Query datastores description: Query the datastore records. operationId: DatastoreConfiguration_QueryDatastores parameters: - name: summary description: Only summary of the records required in: query required: false schema: type: boolean - name: namePattern description: Datastore name pattern to be matched. in: query required: false schema: type: string - name: dsType description: Datastore type to be matched in: query required: false schema: type: integer format: int32 - name: originType description: origin of datastore in: query required: false schema: type: integer format: int32 - name: titlePattern description: Datastore title pattern to be matched. in: query required: false schema: type: string - 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: 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/Datastores' '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 edge-node 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/storage components: schemas: Datastores: type: object properties: summaryByType: description: Type distribution summary of filtered Datastore records allOf: - $ref: '#/components/schemas/Summary' list: type: array items: $ref: '#/components/schemas/DatastoreInfo' description: List of filtered Datastore records summaryByCategory: description: Category distribution summary of filtered Datastore records allOf: - $ref: '#/components/schemas/Summary' summaryByOrigin: description: datstore by origin summary allOf: - $ref: '#/components/schemas/Summary' next: description: Responded page details of filtered records 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 DatastoreInfo: type: object properties: id: type: string description: System defined universally unique Id of the datastore. readOnly: true pattern: >- [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12} x-zededa-source-issues: - code: inapplicable-constraint pointer: '#/definitions/DatastoreInfo/properties/id' keyword: uniqueItems sourceValue: true name: type: string description: >- User defined name of the datastore, unique across the enterprise. Once datastore 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/DatastoreInfo/properties/name' keyword: uniqueItems sourceValue: true title: type: string description: >- User defined title of the datastore. 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 datastore. maxLength: 256 revision: description: system defined info readOnly: true allOf: - $ref: '#/components/schemas/ObjectRevision' enterpriseId: type: string dsType: description: Datastore type allOf: - $ref: '#/components/schemas/DatastoreType' dsFQDN: type: string description: Datastore Fully Qualified Domain Name dsPath: type: string description: Datastore relative path w.r.t. Datastore root apiKey: type: string region: type: string description: Datastore region - valid for AWS S3 and Azure BlobStorage dsStatus: description: Datastore status allOf: - $ref: '#/components/schemas/DatastoreStatus' dsErr: type: string description: Datastore validation detailed error/status message readOnly: true secret: description: Plain-text sensitive data allOf: - $ref: '#/components/schemas/DatastoreInfoSecrets' encryptedSecrets: type: object additionalProperties: type: string description: Internal - Encrypted sensitive data readOnly: true cryptoKey: type: string description: Internal - Encryption Key context readOnly: true originType: description: Origin type of datastore. readOnly: true allOf: - $ref: '#/components/schemas/Origin' certificateChain: description: Certificate chain of the certificate allOf: - $ref: '#/components/schemas/CertificateChain' needClearText: type: boolean description: knob for sending creds in clear text projectAccessList: type: array items: type: string description: project access list of the datastore isManaged: type: boolean description: >- Managed datastore or not. Managed datastores are created and managed by ZEDEDA. description: Datastore idetail title: Datastore required: - name - title - dsType - dsFQDN - dsPath 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 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 DatastoreType: type: string enum: - DATASTORE_TYPE_UNSPECIFIED - DATASTORE_TYPE_HTTP - DATASTORE_TYPE_HTTPS - DATASTORE_TYPE_AWSS3 - DATASTORE_TYPE_SFTP - DATASTORE_TYPE_CONTAINERREGISTRY - DATASTORE_TYPE_AZUREBLOB - DATASTORE_TYPE_ZEDEDAS3 - DATASTORE_TYPE_ZEDEDABLOB - DATASTORE_TYPE_FILE_STORAGE default: DATASTORE_TYPE_UNSPECIFIED description: |- - DATASTORE_TYPE_HTTP: Datastore hosted on HTTP server - DATASTORE_TYPE_HTTPS: Datastore hosted on HTTPS server - DATASTORE_TYPE_AWSS3: Datastore hosted on AWS S3 - DATASTORE_TYPE_SFTP: Datastore hosted on SFTP server - DATASTORE_TYPE_CONTAINERREGISTRY: Datastore hosted on Container Registry (e.g. Dockerhub, Azure Container Registry etc.) - DATASTORE_TYPE_AZUREBLOB: Datastore hosted on Azure BlobStorage - DATASTORE_TYPE_ZEDEDAS3: ZEDEDA Owned and Operated datastore hosted on AWS S3 - DATASTORE_TYPE_ZEDEDABLOB: ZEDEDA Owned and Operated datastore hosted on Azure BlobStorage - DATASTORE_TYPE_FILE_STORAGE: Datastore hosted on File Storage (e.g. HTTP, HTTPS, AWS S3, SFTP, Azure Blob, etc.) title: Datastore type DatastoreStatus: type: string enum: - DATASTORE_STATUS_UNSPECIFIED - DATASTORE_STATUS_CREATED - DATASTORE_STATUS_VERIFYING - DATASTORE_STATUS_ACTIVE - DATASTORE_STATUS_INACTIVE - DATASTORE_STATUS_FAILED default: DATASTORE_STATUS_UNSPECIFIED title: Datastore status DatastoreInfoSecrets: type: object properties: apiKey: type: string description: Datastore access API key in plain-text apiPasswd: type: string description: Datastore access API password in plain-text Origin: type: string enum: - ORIGIN_UNSPECIFIED - ORIGIN_IMPORTED - ORIGIN_LOCAL - ORIGIN_GLOBAL - ORIGIN_APP_PROFILE_LOCAL default: ORIGIN_UNSPECIFIED description: >- - ORIGIN_UNSPECIFIED: default options, which says no Operation/Invalid Operation - ORIGIN_IMPORTED: Object imported from global enterprise. - ORIGIN_LOCAL: Objectl created locally. - ORIGIN_GLOBAL: Object created in global store, to use this type user should have root previlage. - ORIGIN_APP_PROFILE_LOCAL: Object created via App profile title: 'OriginType : enum specifies the Object orgigin type' CertificateChain: type: object properties: certificates: type: array items: $ref: '#/components/schemas/Certificate' description: >- List of Certificate object holds the details of certificate like cert block, encryption type, validity, subject etc 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 Certificate: type: object properties: cert: type: string description: base64 string of the parent certificate title: certificate details pvtKey: type: string description: base64 string of the parent pvt key publicKey: type: string description: base63 string of the public key passPhrase: type: string description: >- pass phase for the pvt key, this has to be filled if pvt key is encrypted with a pass phrase exportable: type: boolean description: Indicates if the private key can be exported. reuseKey: type: boolean description: Indicates if the same key pair will be used on certificate renewal. encryptedSecrets: type: object additionalProperties: type: string description: user encrypted secrets map title: secrets encryption cryptoKey: type: string description: Crypto Key for decrypting user secret information publicKeyAlgorithm: type: string description: Public key algorithm. title: encryption algorithm rsaEcryption: description: RSA encryption algorithm of the certificate allOf: - $ref: '#/components/schemas/RSA' ecdsaEncryption: description: ECDSA encryption algorithm of the certificate allOf: - $ref: '#/components/schemas/ECDSA' validFrom: type: string format: date-time description: Certificate validatity start time title: certificate validity validTill: type: string format: date-time description: Certificate validatity start time sanValues: description: >- This holds the alternative name values like URIs, domain names IPs etc. title: Subject alternative name values allOf: - $ref: '#/components/schemas/SANValues' subject: description: Parameters for the subject of the X509 component of a certificate. allOf: - $ref: '#/components/schemas/Subject' issuer: description: Parameters for the issuer of the X509 component of a certificate. allOf: - $ref: '#/components/schemas/Subject' serialNumber: type: string description: >- Unique identifier for each Certificate generated by an Certificate Issuer. basicContraintsValid: type: boolean description: This fields tells the basic constraints like isCA are correct. keyUsage: type: integer format: int32 description: >- Key usage extensions define the purpose of the public key contained in a certificate. extendedKeyUsage: type: array items: type: string description: Sequence of extended key usages. signatureAlgorithm: type: string RSA: type: object properties: rsaBits: type: string format: int64 description: RSA Encryption Key bit size. ECDSA: type: object properties: curve: type: string description: ECDSA curve to be used while signing the certificate. SANValues: type: object properties: hosts: type: array items: type: string description: List of permitted hosts. emaildIds: type: array items: type: string description: List of permitted email addresses. uris: type: array items: type: string description: List of permitted URIs. ips: type: array items: type: string description: List of permitted IP addresses. dns: type: array items: type: string description: List of permitted DNS names. upns: type: array items: type: string description: List of permitted User principal names. Subject: type: object properties: commonName: type: string description: Certificate common name. country: type: array items: type: string description: List of countries. organization: type: array items: type: string description: List of organization. organizationalUnit: type: array items: type: string description: List of Organizational Unit. locality: type: array items: type: string description: List of locallity. postalCode: type: array items: type: string description: List of Postal codes. province: type: array items: type: string description: List of List of Prvince. serialNumber: type: string description: Subject cerial number securitySchemes: BearerToken: type: http description: Bearer token for user session scheme: bearer ````