Retrieve an instance

GET/compute/{connection_id}/instance/{id}

Parameters

fieldsstring array
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
connection_idstring required
ID of the connection
idstring required
ID of the Instance

Returns

Response fieldTypeRequiredDescription
idstringNoUnique identifier for the instance
created_atstring (date-time)NoWhen the instance was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)NoWhen the instance was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestringNoDisplay name of the instance
typeenumNoThe kind of compute unit Values: CONTAINER, VM, BAREMETAL, SANDBOX, OTHER
statusenumNoNormalized 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_reasonstringNoVendor explanation of the current status (eg. shutdown or failure reason)
allowed_actionsenumNoLifecycle actions the vendor currently allows Values: START, STOP, RESTART, PAUSE, RESUME, TERMINATE
marketenumNoPricing market the instance runs in Values: ON_DEMAND, SPOT, RESERVED, COMMUNITY, OTHER
region_idstringNoThe region the instance runs in
template_idstringNoThe template the instance was created from
imagestringNoContainer or OS image, when not created from a template
source_snapshot_idstringNoThe snapshot the instance was restored or forked from
parent_instance_idstringNoThe instance this one was forked from
gputype_idstringNoThe GPU or instance type of this instance
gpu_modelenumNoNormalized 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_countnumberNoNumber of GPUs attached (0 for CPU-only)
skustringNoThe vendor's own SKU or size name
cpu_countnumberNoNumber of vCPUs; may be fractional
memory_mbnumberNoSystem memory in MiB
disk_mbnumberNoDisk size in MiB
architectureenumNoCPU architecture Values: X86_64, ARM64, OTHER
price_amountnumberNoList price for the instance
price_unitenumNoUnit that price_amount is quoted in Values: PER_GPU_HOUR, PER_INSTANCE_HOUR, OTHER
currencystringNoCurrency of price_amount (ISO 4217)
volume_idsstring[]NoVolumes mounted on the instance
endpointsComputeEndpoint[]NoExposed ports and their URLs
endpoints[].portnumberNoThe port inside the instance
endpoints[].protocolenumNoThe protocol served on this port Values: HTTP, HTTPS, TCP, UDP, OTHER
endpoints[].urlstringNoPublic or proxied URL for this port
endpoints[].is_auth_requiredbooleanNoWhether the URL requires a vendor access token
sshobjectNoSSH connection details
ssh.hoststringNoSSH host
ssh.portnumberNoSSH port
ssh.usernamestringNoSSH username
has_internet_accessbooleanNoWhether outbound network access is allowed
timeout_secondsnumberNoSeconds until the instance expires; set on update to extend it
expires_atstring (date-time)NoWhen the instance will expire (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
on_expireenumNoWhat happens when the instance expires Values: TERMINATE, PAUSE, STOP, OTHER
idle_timeout_secondsnumberNoSeconds of inactivity before on_idle applies
on_idleenumNoWhat happens when the instance is idle Values: TERMINATE, PAUSE, STOP, OTHER
project_identifierstringNoVendor project, team or app that groups the instance (reference to TaskProject)
service_idstringNoThe service (app) this instance runs for, on hosting platforms
envComputeEnv[]NoEnvironment variables (write-only values)
env[].namestringYesEnvironment variable name
env[].valuestringNoEnvironment variable value (write-only; never returned)
started_atstring (date-time)NoWhen the instance last started (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
terminated_atstring (date-time)NoWhen the instance was terminated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
metadataComputeMetadata[]NoVendor labels, tags and metadata
metadata[].idstringNo
metadata[].slugstringNoThe label, tag or metadata key
metadata[].valueobjectNoThe label, tag or metadata value
metadata[].namespacestringNoThe origin of the value (eg. labels, tags, metadata)
metadata[].formatenumNoThe data type of the value Values: TEXT, NUMBER, DATE, BOOLEAN, ARRAY, OBJECT
metadata[].extra_dataobjectNo

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

  • The integration's own rate limit, passed through.
  • Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.
const options = {
  method: 'GET',
  url: 'https://api.unified.to/compute/5de520f96e439b002043d8dc/instance/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?