Zededa ImageConfiguration API

openapi: 3.2.0
info:
  title: ZEDEDA App Profiles Service AppProfileService Image Configuration API
  description: The ZEDEDA App Profiles Service is part of ZEDEDA Edge Orchestration Platform. This service enables customers to define their app profiles on ZEDEDA platform and to manage them remotely.
  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: /api
security:
- BearerToken: []
tags:
- name: ImageConfiguration
paths:
  /v1/apps/images:
    get:
      summary: Query edge application images
      description: Query the edge application image records.
      operationId: ImageConfiguration_QueryImages
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Images'
        '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'
      parameters:
      - name: summary
        description: Only summary of the records required
        in: query
        required: false
        schema:
          type: boolean
      - name: imageType
        description: "Image type to ne matched.\n\n - IMAGE_TYPE_EVE: Base OS images for edge gateway\n - IMAGE_TYPE_APPLICATION: Edge application images\n - IMAGE_TYPE_EVEPRIVATE: Private Base OS images for edge gateway\n - IMAGE_TYPE_ARTIFACT: Image type to be used for configuration/patch service\n - IMAGE_TYPE_DOCKER_COMPOSE_TAR: Image type to be used for multi-file docker-compose projects\n - IMAGE_TYPE_DOCKER_RUNTIME: Image type to be used for Docker Compose runtime bundles\n - IMAGE_TYPE_ZKS_RUNTIME: Image type to be used for ZKS runtime bundles"
        in: query
        required: false
        schema:
          type: string
          enum:
          - IMAGE_TYPE_UNSPECIFIED
          - IMAGE_TYPE_EVE
          - IMAGE_TYPE_APPLICATION
          - IMAGE_TYPE_EVEPRIVATE
          - IMAGE_TYPE_ARTIFACT
          - IMAGE_TYPE_DOCKER_COMPOSE_TAR
          - IMAGE_TYPE_DOCKER_RUNTIME
          - IMAGE_TYPE_ZKS_RUNTIME
          default: IMAGE_TYPE_UNSPECIFIED
      - name: imageStatus
        description: "Image status to be matched.\n\n - IMAGE_STATUS_CREATED: Image metadata is created\n - IMAGE_STATUS_UPLOADING: Image binary is being uploaded to Datstore\n - IMAGE_STATUS_READY: Image is ready for download\n - IMAGE_STATUS_INUSE: Image is being used by edge applications\n - IMAGE_STATUS_FAILED: Image binary upload has failed\n - IMAGE_STATUS_UPLINKING: Image metadata is being uplinked with Datstore binary"
        in: query
        required: false
        schema:
          type: string
          enum:
          - IMAGE_STATUS_UNSPECIFIED
          - IMAGE_STATUS_CREATED
          - IMAGE_STATUS_PENDING
          - IMAGE_STATUS_UPLOADING
          - IMAGE_STATUS_READY
          - IMAGE_STATUS_INUSE
          - IMAGE_STATUS_ARCHIVED
          - IMAGE_STATUS_MAX
          - IMAGE_STATUS_FAILED
          - IMAGE_STATUS_UPLINKING
          default: IMAGE_STATUS_UNSPECIFIED
      - name: datastoreId
        description: Datastore id to be matched.
        in: query
        required: false
        schema:
          type: string
      - name: imageArch
        description: Image architecture to be matched.
        in: query
        required: false
        schema:
          type: string
          enum:
          - UNSPECIFIED
          - UNDEFINED
          - AMD64
          - ARM64
          default: UNSPECIFIED
      - name: namePattern
        description: Image name pattern to be matched.
        in: query
        required: false
        schema:
          type: string
      - name: originType
        description: origin of image
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - 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
        style: form
        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
      tags:
      - ImageConfiguration
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/storage
    post:
      summary: Create edge application image
      description: Create an edge application image record.
      operationId: ImageConfiguration_CreateImage
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ZsrvResponse'
        '400':
          description: Bad Request. The API gateway did not process the request because of missing parameter or invalid value of 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'
        '409':
          description: Conflict. The API gateway did not process the request because this edge application image record will conflict with an already existing edge application image record.
          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'
      parameters:
      - name: X-Request-Id
        in: header
        required: false
        description: User-Agent specified id to track a request
        schema:
          type: string
      tags:
      - ImageConfiguration
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/storage
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImageConfig'
        required: true
  /v1/apps/images/baseos/latest:
    get:
      summary: Query latest version of EVE image for each hardware architecture
      description: Query the latest version of EVE image for each hardware architecture.
      operationId: ImageConfiguration_QueryLatestImageVersions
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Images'
        '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'
      parameters:
      - name: namePattern
        description: Image Architecture pattern to be matched.
        in: query
        required: false
        schema:
          type: string
      - name: fields
        description: fields list for variable response
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            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
        style: form
        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
      tags:
      - ImageConfiguration
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/storage
    delete:
      summary: Delete edge application image
      description: Delete an edge application image record.
      operationId: ImageConfiguration_DeleteLatestImage
      responses:
        '200':
          description: A successful response.
          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'
        '404':
          description: Not Found. The API gateway did not process the request because the requested resource could not be found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ZsrvResponse'
        '409':
          description: Conflict. The API gateway did not process the request because there are edge application bundles using this edge application image
          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'
      parameters:
      - name: id
        description: System defined universally unique Id of the image
        in: query
        required: false
        schema:
          type: string
      - name: X-Request-Id
        in: header
        required: false
        description: User-Agent specified id to track a request
        schema:
          type: string
      tags:
      - ImageConfiguration
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/storage
    put:
      summary: Mark Eve image as latest
      description: Mark Eve image as latest for a given hardware architecture.
      operationId: ImageConfiguration_MarkEveImageLatest
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ZsrvResponse'
        '400':
          description: Bad Request. The API gateway did not process the request because of missing parameter or invalid value of 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'
        '404':
          description: Not Found. The API gateway did not process the request because the requested resource could not be found.
          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'
      parameters:
      - name: X-Request-Id
        in: header
        required: false
        description: User-Agent specified id to track a request
        schema:
          type: string
      tags:
      - ImageConfiguration
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/storage
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImageConfig'
        required: true
  /v1/apps/images/baseos/latest/hwclass/{imageArch}:
    get:
      summary: Get latest version of EVE image
      description: Query the latest version of EVE image for given hardware architecture.
      operationId: ImageConfiguration_GetLatestImageVersion
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageConfig'
        '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'
        '404':
          description: Not Found. The API gateway did not process the request because the requested resource could not be found.
          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'
      parameters:
      - name: imageArch
        description: 'Image architecture to be matched : ''AMD64'' or ''ARM64''.'
        in: path
        required: true
        schema:
          type: string
      - name: X-Request-Id
        in: header
        required: false
        description: User-Agent specified id to track a request
        schema:
          type: string
      tags:
      - ImageConfiguration
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/storage
    put:
      summary: Mark Eve image as latest
      description: Mark Eve image as latest for a given hardware architecture.
      operationId: ImageConfiguration_MarkEveImageLatest2
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ZsrvResponse'
        '400':
          description: Bad Request. The API gateway did not process the request because of missing parameter or invalid value of 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'
        '404':
          description: Not Found. The API gateway did not process the request because the requested resource could not be found.
          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'
      parameters:
      - name: imageArch
        description: Image Architecture.
        in: path
        required: true
        schema:
          type: string
          enum:
          - UNSPECIFIED
          - UNDEFINED
          - AMD64
          - ARM64
      - name: X-Request-Id
        in: header
        required: false
        description: User-Agent specified id to track a request
        schema:
          type: string
      tags:
      - ImageConfiguration
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/storage
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  description: System defined universally unique Id of the image.
                  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}'
                  uniqueItems: true
                name:
                  type: string
                  description: User defined name of the image, unique across the enterprise. Once image is created, name can’t be changed.
                  maxLength: 256
                  minLength: 3
                  pattern: '[a-zA-Z0-9][a-zA-Z0-9_.-]+'
                  uniqueItems: true
                title:
                  type: string
                  description: User defined title of the image. 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 image.
                  maxLength: 256
                revision:
                  $ref: '#/components/schemas/ObjectRevision'
                  description: system defined info
                  readOnly: true
                imageFormat:
                  $ref: '#/components/schemas/configFormat'
                  description: Image binary format.
                imageRelUrl:
                  type: string
                  description: Image relative path w.r.t. Datastore
                imageSha256:
                  type: string
                  description: Image checksum in SHA256 format
                imageVersion:
                  type: string
                  description: system defined info
                imageStatus:
                  $ref: '#/components/schemas/ImageStatus'
                  description: Image status
                  readOnly: true
                imageType:
                  $ref: '#/components/schemas/ImageType'
                  description: Image type
                datastoreId:
                  type: string
                  description: Datastore Id where image binary is located.
                  title: datastoreId will be deprecated
                  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}'
                imageSizeBytes:
                  type: string
                  format: int64
                  description: Image size in KBytes.
                imageError:
                  type: string
                  description: Image upload/uplink detailed error/status message
                  readOnly: true
                imageLocal:
                  type: string
                  description: Internal image location.
                  readOnly: true
                originType:
                  $ref: '#/components/schemas/Origin'
                  description: Origin type of image.
                  readOnly: true
                projectAccessList:
                  type: array
                  items:
                    type: string
                  description: project access list of the image
                datastoreIdList:
                  type: array
                  items:
                    type: string
                  description: datastore Id list where image binary is located.
                isLTS:
                  type: boolean
                  description: flag to indicate eve image is LTS or not
              description: Image metadata for edge gateway Base OS or for eedge applications.
              title: Image metadata detail
              required:
              - name
              - title
              - imageFormat
              - imageType
              - datastoreId
        required: true
  /v1/apps/images/id/{id}:
    get:
      summary: Get edge application image
      description: Get the configuration (without security details) of an edge application image record.
      operationId: ImageConfiguration_GetImage
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageConfig'
        '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'
        '404':
          description: Not Found. The API gateway did not process the request because the requested resource could not be found.
          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'
      parameters:
      - name: id
        description: System defined universally unique Id of the image
        in: path
        required: true
        schema:
          type: string
      - name: X-Req

# --- truncated at 32 KB (81 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zededa/refs/heads/main/openapi/zededa-imageconfiguration-api-openapi.yml