Skip to main content
GET
Get Instance

Headers

Authorization
string
required

Bearer authentication format, e.g.: Bearer {{API_KEY}}.

Path Parameters

instance_id
string
required

Instance ID. String, length: 1-255 characters.

Response

200 - application/json

OK

id
string

Instance ID

Example:

"ca338f12f3"

name
string

Instance name

Example:

"example-instance"

type
enum<string>

Instance type. Allowed values: gpu, cpu

Available options:
gpu,
cpu
Example:

"gpu"

product_id
string

Product ID

Example:

"product-id"

image
string

Image address

Example:

"registry.example.com/namespace/image:tag"

registry_auth_id
string

Registry authentication ID

Example:

"registry-auth-id"

entrypoint
string

Container entrypoint

Example:

""

command
string

Container startup command

Example:

""

billing
object

Billing configuration

envs
object[]

Environment variable list

ports
object[]

Exposed port list

resource_specs
object

Resource specification (with system-allocated info)

network
object

VPC network configuration

volumes
object[]

Data disk / network storage mounts

region
string

Region of the instance

Example:

"region-id"

tools
object

Instance tool information

auto_migrate
object

Auto-migrate configuration

status
object

Instance status information

pricing
object

Pricing information

created_at
integer

Creation time. Unix timestamp

Example:

1714464000

last_started_at
integer

Last start time. Unix timestamp

Example:

1714467600

last_stopped_at
integer

Last stop time. Unix timestamp

Example:

0

member_id
string

Creator member ID

Example:

"member-id"

owner_id
string

Owner user ID (team owner UUID)

Example:

"550e8400-e29b-41d4-a716-446655440000"

region_version
string

Instance version

Example:

"v1.0"

Last modified on June 26, 2026