--- title: "Retrieve a deployment" url: "https://docs.unified.to/compute/deployment/Retrieve_a_deployment" description: "Retrieve a deployment with Unified's Deployment API (GET /compute/{connection_id}/deployment/{id}). Filter by fields and raw. Supported by 2 Deployment integrations." --- # Retrieve a deployment GET/compute/{connection\_id}/deployment/{id} ## Parameters **fields**string array id created\_at updated\_at service\_id status trigger environment commit\_identifier commit\_message branch image url started\_at finished\_at error 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 Deployment ## Returns [ComputeDeployment](https://docs.unified.to/compute/deployment/model.md) | Response field | Type | Required | Description | | ------------------------ | -------------------------------------------------------------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | id | string | No | Unique identifier for the deployment | | created\_at | string (date-time) | No | When the deployment was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | updated\_at | string (date-time) | No | When the deployment was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | service\_id | string | No | The service this deployment belongs to | | status | enum | No | Normalized deployment status; set to CANCELED on update to cancel Values: QUEUED, BUILDING, DEPLOYING, LIVE, FAILED, CANCELED, SUPERSEDED, OTHER | | trigger | enum | No | What started the deployment Values: GIT, MANUAL, API, ROLLBACK, OTHER | | environment | enum | No | Target environment Values: PRODUCTION, PREVIEW, DEVELOPMENT, OTHER | | commit\_identifier | string | No | Source commit SHA (reference to RepoCommit) | | commit\_message | string | No | Source commit message | | branch | string | No | Source branch | | image | string | No | Container image deployed, for image-based services | | url | string | No | URL where this deployment is served | | started\_at | string (date-time) | No | When the build started (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | finished\_at | string (date-time) | No | When the deployment finished (live, failed or canceled) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | error | string | No | Failure description | | metadata | [ComputeMetadata](https://docs.unified.to/compute/deployment/Retrieve%5Fa%5Fdeployment.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.getComputeDeployment({ connectionId, id, fields: '', raw: '', }); ``` ### Node.js (axios) ```javascript const options = { method: 'GET', url: 'https://api.unified.to/compute/5de520f96e439b002043d8dc/deployment/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/deployment/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/deployment/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/deployment/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/deployment/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/deployment/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/deployment/5de520f96e439b002043d8d8?fields=&raw=' \ --header 'accept: application/json' \ --header 'authorization: .....' ```