Skip to main content
GET
Get Instance

Request Headers

string
requis
Enum: application/json
string
requis
Bearer authentication format, for example: Bearer {{API Key}}.

Query Parameters

string
requis
ID of the instance being queried.

Response

string
requis
Instance ID.
string
requis
Instance name.
string
requis
Cluster ID.
string
requis
Name of the cluster.
string
requis
Container image URL.
string
requis
Image registry authentication information.
string
requis
Container startup command.
string
requis
Container startup entrypoint.
string
requis
Number of CPU cores allocated to the instance.
string
requis
Memory size allocated to the instance, in GB.
string
requis
Number of GPU cards allocated to the instance.
string
requis
Instance status. 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
object
Error information when instance creation fails or the instance is unavailable.
object
VPC network information for the instance.
object[]
requis
Instance port mapping information.
object[]
Storage configuration for the instance.
object[]
Node information.
object[]
Tasks currently running on the instance.
object[]
Instance environment variable information.
object
Instance SSH connection information.
object
Instance WebSSH connection information.
object
Jupyter connection information for the instance (if available).
object
Instance log connection information (HTTP Stream).
string
Instance type.
string
requis
Billing mode for the instance. Values:
  • onDemand: Pay-as-you-go billing.
  • monthly: Subscription (monthly or yearly) billing.
  • spot: Spot instance billing.
string
Expiration time for subscription instances. For pay-as-you-go instances, returns -1.
integer
Free system disk size (GB).
integer
Number of days data is retained after the instance is shut down.
Dernière modification le 15 mai 2026