List images visible to your account

GET

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

GET

/api/v3/images/

curl https://api.dsx-air.nvidia.com/api/v3/images/ \
     -H "Authorization: Bearer <token>"

{
  "count": 123,
  "results": [
    {
      "id": "string",
      "name": "string",
      "version": "string",
      "created": "2024-01-15T09:30:00Z",
      "creator": "string",
      "modified": "2024-01-15T09:30:00Z",
      "default_username": "string",
      "default_password": "string",
      "published": true,
      "publicly_published": true,
      "publish_access_record_id": "string",
      "upload_status": "READY",
      "last_uploaded_at": "2024-01-15T09:30:00Z",
      "size": 1,
      "hash": "string",
      "is_owned_by_client": true,
      "mountpoint": "string",
      "minimum_resources": {
        "cpu": 1,
        "memory": 1,
        "storage": 1
      },
      "includes_air_agent": false,
      "cpu_arch": "x86",
      "emulation_type": [
        "string"
      ],
      "emulation_version": "string",
      "provider": "VM",
      "notes": "string",
      "release_notes": "string",
      "user_manual": "string"
    }
  ],
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Required scope: air:image_read (roles: air_image_publisher, air_image_uploader, air_org_admin, air_user)

Alternative: role air_trainee also grants access.

Authentication

AuthorizationBearer

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

Query parameters

cpu_archenumOptional

x86 - x86
ARM - ARM

* `x86` - x86 * `ARM` - ARM

Allowed values:

creatorstringOptional

The email of the client who created the image.

hashstringOptional

includes_air_agentbooleanOptional

is_owned_by_clientbooleanOptional

Whether the client's org owns the image.

limitintegerOptional

Number of results to return per page.

namestringOptional

offsetintegerOptional

The initial index from which to return the results.

orderingenumOptional

Order objects by field. Prefix with - for descending order.

providerenumOptional

VM - VM
CONTAINER - CONTAINER

* `VM` - VM * `CONTAINER` - CONTAINER

Allowed values:

publicly_publishedbooleanOptional

Whether the image is published to all users (public) vs restricted allow-list.

publishedbooleanOptional

searchstringOptional

Search by name or version.

upload_statusenumOptional

The upload status of the image file.

READY - Ready
UPLOADING - Uploading
VALIDATING - Validating
COMPLETE - Complete
PUBLISHING - Publishing
UNPUBLISHING - Unpublishing
COPYING_FROM_IMAGE_SHARE - Copying from image share
PENDING_PUBLISH - Pending Publish
PENDING_UNPUBLISH - Pending Unpublish

The upload status of the image file. * `READY` - Ready * `UPLOADING` - Uploading * `VALIDATING` - Validating * `COMPLETE` - Complete * `PUBLISHING` - Publishing * `UNPUBLISHING` - Unpublishing * `COPYING_FROM_IMAGE_SHARE` - Copying from image share * `PENDING_PUBLISH` - Pending Publish * `PENDING_UNPUBLISH` - Pending Unpublish

versionstringOptional

Response

countinteger

resultslist of objects

nextstring or nullOptionalformat: "uri"

previousstring or nullOptionalformat: "uri"

Errors

400

Bad Request Error

403

Forbidden Error

500

Internal Server Error