> ## Documentation Index
> Fetch the complete documentation index at: https://docs.novita.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List Instances

## Request Headers

**Content-Type** `string` *required*

Enum: `application/json`

**Authorization** `string` *required*

Bearer authentication format, for example: Bearer \{\{API Key}}.

## Query Parameters

**pageSize** `integer` *required*

Maximum number of items returned per page. Integer, value >= 0.

**pageNum** `integer` *required*

Page number to retrieve. Integer, value >= 0.

**name** `string`

Instance name (supports fuzzy search). String, length limit: 0-255 characters.

**productName** `string`

Product name (supports fuzzy search). String, length limit: 0-255 characters.

**status** `string`

Instance status. String, length limit: 0-63 characters. Possible values:

* `toCreate`: Pending creation
* `creating`: Creating
* `pulling`: Pulling image
* `running`: Running
* `toStart`: Pending start
* `starting`: Starting
* `toStop`: Pending stop
* `stopping`: Stopping
* `exited`: Stopped
* `toRestart`: Pending restart
* `restarting`: Restarting
* `toRemove`: Pending deletion
* `removing`: Deleting
* `removed`: Deleted
* `toReset`: Pending reset (upgrade)
* `resetting`: Resetting
* `migrating`: Migrating
* `freezing`: Freezing

## Response

**instances** `object[]` *required*

Instance information.

**properties**

**id** `string` *required*

Instance ID.

**name** `string` *required*

Instance name.

**clusterId** `string` *required*

Cluster ID.

**clusterName** `string`

Cluster name.

**status** `string` *required*

Instance status.

**imageUrl** `string` *required*

Container image URL.

**imageAuthId** `string`

Image repository authentication information.

**command** `string`

Container startup command.

**entrypoint** `string`

Container startup entrypoint.

**cpuNum** `string` *required*

Number of CPU cores for the instance.

**memory** `string` *required*

Memory size of the instance (GB).

**gpuNum** `string` *required*

Number of GPUs for the instance.

**portMappings** `object[]`

Instance port information.

**properties**

**port** `integer` *required*

Port value.

**type** `string` *required*

Port type.

**productId** `string` *required*

Product ID used to deploy the instance.

**productName** `string` *required*

Product name used to deploy the instance.

**rootfsSize** `integer` *required*

Root filesystem size (GB).

**volumeMounts** `object[]`

Instance storage configuration.

**properties**

**type** `string`

Storage type. Values:

* network: Cloud storage.
* local: Local storage.

**size** `string`

Storage capacity.

**id** `string`

Cloud storage ID. Returned when type = network.

**mountPath** `string`

Storage mount path.

**statusError** `object`

Error information when instance creation fails or the instance is unavailable.

**properties**

**state** `string`

Abnormal instance status.

**message** `string`

Error message.

**envs** `object[]`

Instance environment variable information.

**properties**

**key** `string`

Environment variable name.

**value** `string`

Environment variable value.

**kind** `string`

Instance type.

**billingMode** `string` *required*

Billing mode for the instance. Values:

* onDemand: Pay-as-you-go billing.
* monthly: Subscription (monthly or yearly) billing.
* spot: Spot instance billing.

**endTime** `string`

Expiration time for subscription instances. For pay-as-you-go instances, returns -1.

**spotStatus** `string`

Spot instance status. Values:

* `running`: Running
* `notified`: Notified for reclaim
* `reclaiming`: Being reclaimed
* `terminated`: Terminated

**spotReclaimTime** `string`

Spot instance reclaim time. Value "0" means reclaim has not started.

Total number of results.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.