--- title: "Retrieve a service" url: "https://docs.unified.to/compute/service/Retrieve_a_service" description: "Retrieve a service with Unified's Service API (GET /compute/{connection_id}/service/{id}). Filter by fields and raw. Supported by 2 Service integrations." --- # Retrieve a service GET/compute/{connection\_id}/service/{id} ## Parameters **fields**string array id created\_at updated\_at name type status runtime region\_id gputype\_id sku instance\_count min\_instance\_count max\_instance\_count repo\_url branch image build\_command start\_command url project\_identifier env 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 Service ## Returns [ComputeService](https://docs.unified.to/compute/service/model.md) | Response field | Type | Required | Description | | ------------------------ | -------------------------------------------------------------------------------------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------- | | id | string | No | Unique identifier for the service (app or project) | | created\_at | string (date-time) | No | When the service was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | updated\_at | string (date-time) | No | When the service was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | name | string | No | Display name of the service | | type | enum | No | The kind of service Values: WEB, WORKER, CRON, STATIC, PRIVATE, OTHER | | status | enum | No | Normalized status; set to SUSPENDED or LIVE on update to suspend or resume Values: CREATING, DEPLOYING, LIVE, SUSPENDED, FAILED, OTHER | | runtime | string | No | Runtime or framework (eg. node, python, docker, nextjs) | | region\_id | string | No | The region the service runs in | | gputype\_id | string | No | The plan or instance type the service runs on | | sku | string | No | The vendor's own plan or size name | | instance\_count | number | No | Current number of running instances | | min\_instance\_count | number | No | Autoscaling minimum | | max\_instance\_count | number | No | Autoscaling maximum | | repo\_url | string | No | Source repository URL | | branch | string | No | Source branch deployed | | image | string | No | Container image, for image-based services | | build\_command | string | No | Build command | | start\_command | string | No | Start command | | url | string | No | Public URL of the service | | project\_identifier | string | No | Vendor project, team or environment that groups the service (reference to TaskProject) | | env | [ComputeEnv](https://docs.unified.to/compute/service/Retrieve%5Fa%5Fservice.md#ComputeEnv)\[\] | No | Environment variables (write-only values) set when creating the service | | env\[\].name | string | Yes | Environment variable name | | env\[\].value | string | No | Environment variable value (write-only; never returned) | | metadata | [ComputeMetadata](https://docs.unified.to/compute/service/Retrieve%5Fa%5Fservice.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.getComputeService({ connectionId, id, fields: '', raw: '', }); ``` ### Node.js (axios) ```javascript const options = { method: 'GET', url: 'https://api.unified.to/compute/5de520f96e439b002043d8dc/service/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/service/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/service/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/service/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/service/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/service/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/service/5de520f96e439b002043d8d8?fields=&raw=' \ --header 'accept: application/json' \ --header 'authorization: .....' ```