> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/dsx-air/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/dsx-air/_mcp/server.

# Update individual fields of an os_image manifest

PATCH https://api.dsx-air.nvidia.com/api/v3/manifests/os-images/{id}/
Content-Type: application/json

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

Reference: https://docs.nvidia.com/dsx-air/api-reference/manifests/api-v-3-manifests-os-images-partial-update

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Path parameters

- `id` (string, required) — A UUID string identifying this os image manifest.

### Body (application/json)

This endpoint expects an object.

- `os_template_partition` (string, optional, nullable) — 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.
- `capabilities` (object, optional) — OS image capability flags. Presence of a key means the capability is supported. Unknown keys are rejected.
  - `vsock` (object, optional) — Indicates the OS image supports vsock communication.
- `platforms` (map from string to object, optional) — Pinned platforms keyed by hardware model name. Each value carries the platform information and platform template versions for that model.
  - `platform_information_version` (string, required, nullable) — Version of the platform information to pin for this model within this OS image manifest. `null` means no default pin is defined here; a node-level override can still supply platform information at simulation time.
  - `os_template_version` (string, required, nullable) — Version of the OS template to pin for this model within this OS image manifest. `null` means no default pin is defined here; a node-level override can still supply an OS template at simulation time.

## Response

### 200

- `id` (string, required)
- `created` (datetime, required)
- `modified` (datetime, required)
- `image` (string, required) — The image this manifest describes.
- `os_type` (string, required) — 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.
- `creator` (string, required, nullable) — The username of the user who created the manifest.
- `os_template_partition` (string, optional, nullable) — 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.
- `capabilities` (object, optional) — OS image capability flags. Presence of a key means the capability is supported. Unknown keys are rejected.
  - `vsock` (object, optional) — Indicates the OS image supports vsock communication.
- `platforms` (map from string to object, optional) — Pinned platforms keyed by hardware model name. Each value carries the platform information and platform template versions for that model.
  - `platform_information_version` (string, required, nullable) — Version of the platform information to pin for this model within this OS image manifest. `null` means no default pin is defined here; a node-level override can still supply platform information at simulation time.
  - `os_template_version` (string, required, nullable) — Version of the OS template to pin for this model within this OS image manifest. `null` means no default pin is defined here; a node-level override can still supply an OS template at simulation time.

## Errors

### 400 Bad Request Error

- `detail` (string, required) — Description of an error.
- `request_id` (string, required, nullable) — ID assigned to the request which encountered the error. Should be provided when opening a support case.
- `type` (enum, required) — Specific type of a 400 error. * `PROTECTED` - Instance may not be deleted as it is being referenced by other instances. * `VALIDATION` - Validation errors encountered during payload processing.
  - Allowed values: `PROTECTED`, `VALIDATION`
- `protected_instances` (list of object, optional) — Instances which bar the current instance from being deleted. Only defined when `type` is set to `PROTECTED`.
  - `id` (string, required) — ID of the instance.
  - `type` (string, required) — Type of the instance.
- `validation_errors` (map from string to list of object or object or map from string to any or list of object, optional) — Validation errors encountered during payload processing. Only defined when `type` is set to `VALIDATION`.

### 403 Forbidden Error

- `detail` (string, required) — Description of an error.
- `request_id` (string, required, nullable) — ID assigned to the request which encountered the error. Should be provided when opening a support case.

### 404 Not Found Error

- `request_id` (string, required, nullable) — ID assigned to the request which encountered the error. Should be provided when opening a support case.
- `detail` (string, optional, default: No object matches the given query.) — Description of an error.

### 500 Internal Server Error

- `request_id` (string, required, nullable) — ID assigned to the request which encountered the error. Should be provided when opening a support case.
- `code` (string, required) — Error code which identifies the error. Should be provided when opening a support case.
- `detail` (string, optional, default: An unexpected error has occurred. Please contact NVIDIA Air support for further assistance.) — Description of an error.

## Examples

### Example response

**Request**

```json
undefined
```

**Response**

```json
{
  "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"
    }
  }
}
```

**SDK Code**

```python Example response
import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.patch(url, headers=headers)

print(response.json())
```

```javascript Example response
const url = 'https://api.dsx-air.nvidia.com/api/v3/manifests/os-images/id/';
const options = {method: 'PATCH', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Example response
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("PATCH", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Example response
require 'uri'
require 'net/http'

url = URI("https://api.dsx-air.nvidia.com/api/v3/manifests/os-images/id/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java Example response
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://api.dsx-air.nvidia.com/api/v3/manifests/os-images/id/")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Example response
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.dsx-air.nvidia.com/api/v3/manifests/os-images/id/', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp Example response
using RestSharp;

var client = new RestClient("https://api.dsx-air.nvidia.com/api/v3/manifests/os-images/id/");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Example response
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.dsx-air.nvidia.com/api/v3/manifests/os-images/id/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Example request

**Request**

```json
{
  "platforms": {
    "SN2700": {
      "platform_information_version": "001",
      "os_template_version": "1"
    },
    "SN5600": {
      "platform_information_version": "002",
      "os_template_version": "1"
    }
  }
}
```

**Response**

```json
{
  "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"
    }
  }
}
```

**SDK Code**

```python Example request
import requests

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

payload = { "platforms": {
        "SN2700": {
            "platform_information_version": "001",
            "os_template_version": "1"
        },
        "SN5600": {
            "platform_information_version": "002",
            "os_template_version": "1"
        }
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.json())
```

```javascript Example request
const url = 'https://api.dsx-air.nvidia.com/api/v3/manifests/os-images/id/';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"platforms":{"SN2700":{"platform_information_version":"001","os_template_version":"1"},"SN5600":{"platform_information_version":"002","os_template_version":"1"}}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Example request
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"platforms\": {\n    \"SN2700\": {\n      \"platform_information_version\": \"001\",\n      \"os_template_version\": \"1\"\n    },\n    \"SN5600\": {\n      \"platform_information_version\": \"002\",\n      \"os_template_version\": \"1\"\n    }\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Example request
require 'uri'
require 'net/http'

url = URI("https://api.dsx-air.nvidia.com/api/v3/manifests/os-images/id/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"platforms\": {\n    \"SN2700\": {\n      \"platform_information_version\": \"001\",\n      \"os_template_version\": \"1\"\n    },\n    \"SN5600\": {\n      \"platform_information_version\": \"002\",\n      \"os_template_version\": \"1\"\n    }\n  }\n}"

response = http.request(request)
puts response.read_body
```

```java Example request
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://api.dsx-air.nvidia.com/api/v3/manifests/os-images/id/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"platforms\": {\n    \"SN2700\": {\n      \"platform_information_version\": \"001\",\n      \"os_template_version\": \"1\"\n    },\n    \"SN5600\": {\n      \"platform_information_version\": \"002\",\n      \"os_template_version\": \"1\"\n    }\n  }\n}")
  .asString();
```

```php Example request
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.dsx-air.nvidia.com/api/v3/manifests/os-images/id/', [
  'body' => '{
  "platforms": {
    "SN2700": {
      "platform_information_version": "001",
      "os_template_version": "1"
    },
    "SN5600": {
      "platform_information_version": "002",
      "os_template_version": "1"
    }
  }
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp Example request
using RestSharp;

var client = new RestClient("https://api.dsx-air.nvidia.com/api/v3/manifests/os-images/id/");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"platforms\": {\n    \"SN2700\": {\n      \"platform_information_version\": \"001\",\n      \"os_template_version\": \"1\"\n    },\n    \"SN5600\": {\n      \"platform_information_version\": \"002\",\n      \"os_template_version\": \"1\"\n    }\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Example request
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["platforms": [
    "SN2700": [
      "platform_information_version": "001",
      "os_template_version": "1"
    ],
    "SN5600": [
      "platform_information_version": "002",
      "os_template_version": "1"
    ]
  ]] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.dsx-air.nvidia.com/api/v3/manifests/os-images/id/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```