--- title: "Retrieve an instance" url: "https://docs.unified.to/compute/instance/Retrieve_an_instance" description: "Retrieve an instance with Unified's Instance API (GET /compute/{connection_id}/instance/{id}). Filter by fields and raw. Supported by 14 Instance integrations." --- # Retrieve an instance GET/compute/{connection\_id}/instance/{id} ## Parameters **fields**string array id created\_at updated\_at name type status status\_reason allowed\_actions market region\_id template\_id image source\_snapshot\_id parent\_instance\_id gputype\_id gpu\_model gpu\_count sku cpu\_count memory\_mb disk\_mb architecture price\_amount price\_unit currency volume\_ids endpoints ssh has\_internet\_access timeout\_seconds expires\_at on\_expire idle\_timeout\_seconds on\_idle project\_identifier service\_id env started\_at terminated\_at metadata raw Fields to return **raw**string 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\_id**string required ID of the connection **id**string required ID of the Instance ## Returns [ComputeInstance](https://docs.unified.to/compute/instance/model.md) | Response 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](https://docs.unified.to/compute/instance/Retrieve%5Fan%5Finstance.md#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](https://docs.unified.to/compute/instance/Retrieve%5Fan%5Finstance.md#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](https://docs.unified.to/compute/instance/Retrieve%5Fan%5Finstance.md#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 | | ## Errors Errors return the HTTP status code and a JSON body with `statusCode`, `error` (the short label) and `message` (a human-readable detail). ```json { "statusCode": 429, "error": "Too Many Requests", "message": "Too many requests to unified.to API; max requests per minute: N" } ``` | Status | Error | Meaning | | ------ | --------------------- | ------------------------------------------------- | | 400 | Bad Request | The request was malformed or failed validation. | | 401 | Unauthorized | The connection is likely broken; re-authorize it. | | 403 | Forbidden | The connection is missing permissions or scopes. | | 404 | Not Found | The requested resource does not exist. | | 429 | Too Many Requests | Rate limit exceeded (see the two sources below). | | 500 | Internal Server Error | An unexpected error occurred. | | 501 | Not Implemented | Not 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`. ## Code Samples ### Node.js SDK ```javascript import { UnifiedTo } from '@unified-api/typescript-sdk'; const sdk = new UnifiedTo({ security: { jwt: '', }, }); const connectionId = '5de520f96e439b002043d8dc'; const id = '1234'; const results = await sdk.compute.getComputeInstance({ connectionId, id, fields: '', raw: '', }); ``` ### Node.js (axios) ```javascript 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); ``` ### Java ```java AsyncHttpClient client = new DefaultAsyncHttpClient(); client.prepare("GET", "https://api.unified.to/compute/5de520f96e439b002043d8dc/instance/5de520f96e439b002043d8d8?fields=&raw=") .setHeader("accept", "application/json") .setHeader("authorization", ".....") .execute() .toCompletableFuture() .thenAccept(System.out::println) .join(); client.close(); ``` ### Go ```go import ( "fmt" "net/http" "io/ioutil" ) url := `https://api.unified.to/compute/5de520f96e439b002043d8dc/instance/5de520f96e439b002043d8d8?fields=&raw= req, _ := http.NewRequest("GET", url, nil) req.Header.Add("accept", "application/json") req.Header.Add("authorization", ".....") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) ``` ### Python ```python import requests url = "https://api.unified.to/compute/5de520f96e439b002043d8dc/instance/5de520f96e439b002043d8d8?fields=&raw=" headers = { "accept": "application/json", "authorization": "....." } response = requests.get(url, headers=headers) ``` ### PHP ```php $curl = curl_init(); curl_setopt_array($curl, [ CURLOPT_URL => "https://api.unified.to/compute/5de520f96e439b002043d8dc/instance/5de520f96e439b002043d8d8?fields=&raw=", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "accept: application/json", "authorization: ....." ], ]); ``` ### Ruby ```ruby require 'uri' require 'net/http' require 'openssl' url = URI("https://api.unified.to/compute/5de520f96e439b002043d8dc/instance/5de520f96e439b002043d8d8?fields=&raw=") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["accept"] = 'application/json' request["authorization"] = '....' response = http.request(request) puts response.read_body ``` ### cURL ```bash curl --request GET \ --url 'https://api.unified.to/compute/5de520f96e439b002043d8dc/instance/5de520f96e439b002043d8d8?fields=&raw=' \ --header 'accept: application/json' \ --header 'authorization: .....' ```