compute
instance

Create an instance

Changed on
post/compute/{connection_id}/instance

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/compute/{connection_id}/instance
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Request body

idstring

Unique identifier for the instance

created_atstring date-time

When the instance was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

When the instance was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring

Display name of the instance

type'CONTAINER' | 'VM' | 'BAREMETAL' | 'SANDBOX' | 'OTHER'

The kind of compute unit

status'PROVISIONING' | 'STARTING' | 'RUNNING' | 'STOPPING' | 'STOPPED' | 'PAUSING' | 'PAUSED' | 'RESUMING' | 'RESTARTING' | 'TERMINATING' | 'TERMINATED' | 'PREEMPTED' | 'ERROR' | 'OTHER'

Normalized lifecycle status; set on update to start, stop, pause, resume, restart or terminate

status_reasonstring

Vendor explanation of the current status (eg. shutdown or failure reason)

allowed_actionsstring[]

Lifecycle actions the vendor currently allows

market'ON_DEMAND' | 'SPOT' | 'RESERVED' | 'COMMUNITY' | 'OTHER'

Pricing market the instance runs in

region_idstring

The region the instance runs in

template_idstring

The template the instance was created from

imagestring

Container or OS image, when not created from a template

source_snapshot_idstring

The snapshot the instance was restored or forked from

parent_instance_idstring

The instance this one was forked from

gputype_idstring

The GPU or instance type of this instance

gpu_model'NVIDIA_GB300' | 'NVIDIA_B300' | 'NVIDIA_GB200' | 'NVIDIA_B200' | 'NVIDIA_GH200' | 'NVIDIA_H200' | 'NVIDIA_H100_SXM' | 'NVIDIA_H100_PCIE' | 'NVIDIA_H100_NVL' | 'NVIDIA_A100_SXM_80GB' | 'NVIDIA_A100_PCIE_80GB' | 'NVIDIA_A100_40GB' | 'NVIDIA_L40S' | 'NVIDIA_L40' | 'NVIDIA_L4' | 'NVIDIA_A40' | 'NVIDIA_A10' | 'NVIDIA_RTX_PRO_6000' | 'NVIDIA_RTX_6000_ADA' | 'NVIDIA_RTX_A6000' | 'NVIDIA_RTX_A5000' | 'NVIDIA_RTX_A4000' | 'NVIDIA_RTX_5090' | 'NVIDIA_RTX_4090' | 'NVIDIA_RTX_3090' | 'NVIDIA_V100' | 'NVIDIA_T4' | 'AMD_MI355X' | 'AMD_MI325X' | 'AMD_MI300X' | 'AMD_MI250' | 'OTHER'

Normalized GPU model

gpu_countnumber

Number of GPUs attached (0 for CPU-only)

skustring

The vendor's own SKU or size name

cpu_countnumber

Number of vCPUs; may be fractional

memory_mbnumber

System memory in MiB

disk_mbnumber

Disk size in MiB

architecture'X86_64' | 'ARM64' | 'OTHER'

CPU architecture

price_amountnumber

List price for the instance

price_unit'PER_GPU_HOUR' | 'PER_INSTANCE_HOUR' | 'OTHER'

Unit that price_amount is quoted in

currencystring

Currency of price_amount (ISO 4217)

volume_idsstring[]

Volumes mounted on the instance

has_internet_accessboolean

Whether outbound network access is allowed

timeout_secondsnumber

Seconds until the instance expires; set on update to extend it

expires_atstring date-time

When the instance will expire (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

on_expire'TERMINATE' | 'PAUSE' | 'STOP' | 'OTHER'

What happens when the instance expires

idle_timeout_secondsnumber

Seconds of inactivity before on_idle applies

on_idle'TERMINATE' | 'PAUSE' | 'STOP' | 'OTHER'

What happens when the instance is idle

project_identifierstring

Vendor project, team or app that groups the instance (reference to TaskProject)

service_idstring

The service (app) this instance runs for, on hosting platforms

started_atstring date-time

When the instance last started (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

terminated_atstring date-time

When the instance was terminated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

rawobject

Raw data from integration

Response

Successful

idstring

Unique identifier for the instance

created_atstring date-time

When the instance was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

When the instance was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring

Display name of the instance

type'CONTAINER' | 'VM' | 'BAREMETAL' | 'SANDBOX' | 'OTHER'

The kind of compute unit

status'PROVISIONING' | 'STARTING' | 'RUNNING' | 'STOPPING' | 'STOPPED' | 'PAUSING' | 'PAUSED' | 'RESUMING' | 'RESTARTING' | 'TERMINATING' | 'TERMINATED' | 'PREEMPTED' | 'ERROR' | 'OTHER'

Normalized lifecycle status; set on update to start, stop, pause, resume, restart or terminate

status_reasonstring

Vendor explanation of the current status (eg. shutdown or failure reason)

allowed_actionsstring[]

Lifecycle actions the vendor currently allows

market'ON_DEMAND' | 'SPOT' | 'RESERVED' | 'COMMUNITY' | 'OTHER'

Pricing market the instance runs in

region_idstring

The region the instance runs in

template_idstring

The template the instance was created from

imagestring

Container or OS image, when not created from a template

source_snapshot_idstring

The snapshot the instance was restored or forked from

parent_instance_idstring

The instance this one was forked from

gputype_idstring

The GPU or instance type of this instance

gpu_model'NVIDIA_GB300' | 'NVIDIA_B300' | 'NVIDIA_GB200' | 'NVIDIA_B200' | 'NVIDIA_GH200' | 'NVIDIA_H200' | 'NVIDIA_H100_SXM' | 'NVIDIA_H100_PCIE' | 'NVIDIA_H100_NVL' | 'NVIDIA_A100_SXM_80GB' | 'NVIDIA_A100_PCIE_80GB' | 'NVIDIA_A100_40GB' | 'NVIDIA_L40S' | 'NVIDIA_L40' | 'NVIDIA_L4' | 'NVIDIA_A40' | 'NVIDIA_A10' | 'NVIDIA_RTX_PRO_6000' | 'NVIDIA_RTX_6000_ADA' | 'NVIDIA_RTX_A6000' | 'NVIDIA_RTX_A5000' | 'NVIDIA_RTX_A4000' | 'NVIDIA_RTX_5090' | 'NVIDIA_RTX_4090' | 'NVIDIA_RTX_3090' | 'NVIDIA_V100' | 'NVIDIA_T4' | 'AMD_MI355X' | 'AMD_MI325X' | 'AMD_MI300X' | 'AMD_MI250' | 'OTHER'

Normalized GPU model

gpu_countnumber

Number of GPUs attached (0 for CPU-only)

skustring

The vendor's own SKU or size name

cpu_countnumber

Number of vCPUs; may be fractional

memory_mbnumber

System memory in MiB

disk_mbnumber

Disk size in MiB

architecture'X86_64' | 'ARM64' | 'OTHER'

CPU architecture

price_amountnumber

List price for the instance

price_unit'PER_GPU_HOUR' | 'PER_INSTANCE_HOUR' | 'OTHER'

Unit that price_amount is quoted in

currencystring

Currency of price_amount (ISO 4217)

volume_idsstring[]

Volumes mounted on the instance

has_internet_accessboolean

Whether outbound network access is allowed

timeout_secondsnumber

Seconds until the instance expires; set on update to extend it

expires_atstring date-time

When the instance will expire (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

on_expire'TERMINATE' | 'PAUSE' | 'STOP' | 'OTHER'

What happens when the instance expires

idle_timeout_secondsnumber

Seconds of inactivity before on_idle applies

on_idle'TERMINATE' | 'PAUSE' | 'STOP' | 'OTHER'

What happens when the instance is idle

project_identifierstring

Vendor project, team or app that groups the instance (reference to TaskProject)

service_idstring

The service (app) this instance runs for, on hosting platforms

started_atstring date-time

When the instance last started (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

terminated_atstring date-time

When the instance was terminated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

rawobject

Raw data from integration

Changes