Instance data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier for the instance |
created_at | string (date-time) | No | When the instance was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | When the instance was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
name | string | No | Display name of the instance |
type | enum | No | The kind of compute unit Values: CONTAINER, VM, BAREMETAL, SANDBOX, OTHER |
status | enum | No | Normalized lifecycle status; set on update to start, stop, pause, resume, restart or terminate Values: PROVISIONING, STARTING, RUNNING, STOPPING, STOPPED, PAUSING, PAUSED, RESUMING, RESTARTING, TERMINATING, TERMINATED, PREEMPTED, ERROR, OTHER |
status_reason | string | No | Vendor explanation of the current status (eg. shutdown or failure reason) |
allowed_actions | enum | No | Lifecycle actions the vendor currently allows Values: START, STOP, RESTART, PAUSE, RESUME, TERMINATE |
market | enum | No | Pricing market the instance runs in Values: ON_DEMAND, SPOT, RESERVED, COMMUNITY, OTHER |
region_id | string | No | The region the instance runs in |
template_id | string | No | The template the instance was created from |
image | string | No | Container or OS image, when not created from a template |
source_snapshot_id | string | No | The snapshot the instance was restored or forked from |
parent_instance_id | string | No | The instance this one was forked from |
gputype_id | string | No | The GPU or instance type of this instance |
gpu_model | enum | No | Normalized GPU model Values: 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 |
gpu_count | number | No | Number of GPUs attached (0 for CPU-only) |
sku | string | No | The vendor's own SKU or size name |
cpu_count | number | No | Number of vCPUs; may be fractional |
memory_mb | number | No | System memory in MiB |
disk_mb | number | No | Disk size in MiB |
architecture | enum | No | CPU architecture Values: X86_64, ARM64, OTHER |
price_amount | number | No | List price for the instance |
price_unit | enum | No | Unit that price_amount is quoted in Values: PER_GPU_HOUR, PER_INSTANCE_HOUR, OTHER |
currency | string | No | Currency of price_amount (ISO 4217) |
volume_ids | string[] | No | Volumes mounted on the instance |
endpoints | ComputeEndpoint[] | No | Exposed ports and their URLs |
endpoints[].port | number | No | The port inside the instance |
endpoints[].protocol | enum | No | The protocol served on this port Values: HTTP, HTTPS, TCP, UDP, OTHER |
endpoints[].url | string | No | Public or proxied URL for this port |
endpoints[].is_auth_required | boolean | No | Whether the URL requires a vendor access token |
ssh | object | No | SSH connection details |
ssh.host | string | No | SSH host |
ssh.port | number | No | SSH port |
ssh.username | string | No | SSH username |
has_internet_access | boolean | No | Whether outbound network access is allowed |
timeout_seconds | number | No | Seconds until the instance expires; set on update to extend it |
expires_at | string (date-time) | No | When the instance will expire (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
on_expire | enum | No | What happens when the instance expires Values: TERMINATE, PAUSE, STOP, OTHER |
idle_timeout_seconds | number | No | Seconds of inactivity before on_idle applies |
on_idle | enum | No | What happens when the instance is idle Values: TERMINATE, PAUSE, STOP, OTHER |
project_identifier | string | No | Vendor project, team or app that groups the instance (reference to TaskProject) |
service_id | string | No | The service (app) this instance runs for, on hosting platforms |
env | ComputeEnv[] | No | Environment variables (write-only values) |
env[].name | string | Yes | Environment variable name |
env[].value | string | No | Environment variable value (write-only; never returned) |
started_at | string (date-time) | No | When the instance last started (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
terminated_at | string (date-time) | No | When the instance was terminated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
metadata | ComputeMetadata[] | No | Vendor labels, tags and metadata |
metadata[].id | string | No | |
metadata[].slug | string | No | The label, tag or metadata key |
metadata[].value | object | No | The label, tag or metadata value |
metadata[].namespace | string | No | The origin of the value (eg. labels, tags, metadata) |
metadata[].format | enum | No | The data type of the value Values: TEXT, NUMBER, DATE, BOOLEAN, ARRAY, OBJECT |
metadata[].extra_data | object | No |
Are we missing anything? Let us know