Update individual fields of an os_image manifest

PATCH

https://api.dsx-air.nvidia.com/api/v3/manifests/os-images/:id/

PATCH

/api/v3/manifests/os-images/:id/

curl -X PATCH https://api.dsx-air.nvidia.com/api/v3/manifests/os-images/id/ \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "platforms": {
    "SN2700": {
      "platform_information_version": "001",
      "os_template_version": "1"
    },
    "SN5600": {
      "platform_information_version": "002",
      "os_template_version": "1"
    }
  }
}'

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created": "2026-06-07T08:36:44.155Z",
  "modified": "2026-06-07T08:36:44.155Z",
  "image": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "os_type": "nvos",
  "creator": "john.doe@example.com",
  "platforms": {
    "SN2700": {
      "platform_information_version": "001",
      "os_template_version": "1"
    },
    "SN5600": {
      "platform_information_version": "002",
      "os_template_version": "1"
    }
  }
}

Required scope: air:image_write (roles: air_image_publisher, air_image_uploader)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequiredformat: "uuid"

A UUID string identifying this os image manifest.

Request

This endpoint expects an object.

os_template_partitionstring or nullOptional1-128 characters

Partition of the boot disk that rendered OS Template files are written into: a filesystem label (e.g. SONiC-OS), or a device path when prefixed with /dev/. Rendered file paths are interpreted relative to the root of this partition. When unset, files are written into the partition named by the image mountpoint.

capabilitiesobjectOptional

OS image capability flags. Presence of a key means the capability is supported. Unknown keys are rejected.

platformsmap from strings to objectsOptional

Pinned platforms keyed by hardware model name. Each value carries the platform information and platform template versions for that model.

Response

idstringRead-onlyformat: "uuid"

createddatetimeRead-only

modifieddatetimeRead-only

imagestringformat: "uuid"

The image this manifest describes.

os_typestring<=128 characters

The OS type the image runs; used as the lookup key into platform templates and platform information, and to resolve the OS type at runtime.

creatorstring or nullRead-only

The username of the user who created the manifest.

os_template_partitionstring or nullOptional<=128 characters

capabilitiesobjectOptional

OS image capability flags. Presence of a key means the capability is supported. Unknown keys are rejected.

platformsmap from strings to objectsOptional

Pinned platforms keyed by hardware model name. Each value carries the platform information and platform template versions for that model.

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error