> 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. # List all os_image manifests GET https://api.dsx-air.nvidia.com/api/v3/manifests/os-images/ **Required scope:** `air:image_read` (roles: `air_image_publisher`, `air_image_uploader`, `air_org_admin`, `air_user`) Reference: https://docs.nvidia.com/dsx-air/api-reference/manifests/api-v-3-manifests-os-images-list ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Request ### Query parameters - `image` (string, optional) — Filter by the UUID of the image the manifest describes. - `limit` (integer, optional) — Number of results to return per page. - `offset` (integer, optional) — The initial index from which to return the results. - `ordering` (enum, optional) — Order objects by field. Prefix with `-` for descending order. - Allowed values: `-created`, `-modified`, `created`, `modified` - `os_type` (string, optional) — Filter by the OS type. - `search` (string, optional) — Search by `os_type`, `image_name`, `image_id`, or `creator`. ## Response ### 200 - `count` (integer, required) - `results` (list of object, required) - `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. - `next` (string, optional, nullable) - `previous` (string, optional, nullable) ## 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. ### 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 **Response** ```json { "count": 123, "results": [ { "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" } } } ], "next": "http://api.example.org/accounts/?offset=400&limit=100", "previous": "http://api.example.org/accounts/?offset=200&limit=100" } ``` **SDK Code** ```python Example response import requests url = "https://api.dsx-air.nvidia.com/api/v3/manifests/os-images/" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript Example response const url = 'https://api.dsx-air.nvidia.com/api/v3/manifests/os-images/'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; 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/" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") 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/") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java Example response import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.dsx-air.nvidia.com/api/v3/manifests/os-images/") .header("Authorization", "Bearer ") .asString(); ``` ```php Example response request('GET', 'https://api.dsx-air.nvidia.com/api/v3/manifests/os-images/', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp Example response using RestSharp; var client = new RestClient("https://api.dsx-air.nvidia.com/api/v3/manifests/os-images/"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift Example response import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.dsx-air.nvidia.com/api/v3/manifests/os-images/")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" 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() ```