Sign in
Images

Initiate a image version upload

Changed on
post/api/v1/images/{tenant}/{name}/versions

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/images/{tenant}/{name}/versions
  • Auth: none declared

Path parameters

tenantstring required
namestring required

Request body

descriptionstring

Free-text version description.

displayNamestring

Human-readable version label.

source'webUpload' | 'oras' | 'dockerPush' | 'external'

How an artifact version was added.

sourceImageRefstring

Remote image reference to sync (required when source=external).

specImageSpec required

Artifact-side spec for kind=image; pass-through to artifacts.

versionstring required

Image version (tag) to create.

Example request

{
  "description": "Training image with PyTorch 2.3 and CUDA 12.",
  "displayName": "PyTorch Training 2.3.0",
  "source": "dockerPush",
  "spec": {
    "purpose": "training"
  },
  "version": "2.3.0"
}

Response

Upload initiated; returns credentials and a image handle.

expiresAtstring date-time

Expiry time of the upload credentials.

idstring uuid required

Identifier of the newly initiated image version.

storageKind'oci' | 's3'

Backing store of the push target (oci, s3).

uploadCredentialsobject

Short-lived credentials for pushing the image.

uristring required

Push target URI for the image content.

Example response

{
  "expiresAt": "2026-06-28T09:30:00Z",
  "id": "a1b2c3d4-5e6f-7081-92a3-b4c5d6e7f809",
  "storageKind": "oci",
  "uploadCredentials": {
    "password": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
    "username": "upload-token"
  },
  "uri": "oci://registry.axisml.io/team-vision/pytorch-train:2.3.0"
}

Changes

  • d51e2e0e6970Revision changes
    • breaking

      added to the request property allOf list

    • breaking

      added to the request property allOf list

    • breaking

      removed the enum value dockerPush of the request property

    • breaking

      removed the enum value external of the request property

    • breaking

      removed the enum value oras of the request property

    • breaking

      removed the enum value webUpload of the request property

    • breaking

      the request property type changed from string to no type

    • breaking

      the request property type changed from object to no type