--- title: "Create a volume" url: "https://docs.unified.to/compute/volume/Create_a_volume" description: "Create a volume with Unified's Volume API (POST /compute/{connection_id}/volume). Filter by fields and raw. Supported by 11 Volume integrations." --- # Create a volume POST/compute/{connection\_id}/volume ## Parameters **fields**string array id created\_at updated\_at name type status size\_mb used\_mb region\_id availability\_zone instance\_ids 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 ## Payload **id**string Unique identifier for the volume **created\_at**date-time When the volume was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) **updated\_at**date-time When the volume was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) **name**string Display name of the volume **type** enum Valid values: "STANDARD" "HIGH\_PERFORMANCE" "SHARED" "LOCAL" "OTHER" The kind of volume **status** enum Valid values: "CREATING" "AVAILABLE" "IN\_USE" "DELETING" "ERROR" "OTHER" Normalized volume status **size\_mb**number Provisioned size in MiB **used\_mb**number Used space in MiB **region\_id**string The region the volume lives in **availability\_zone**string The availability zone within the region, where the vendor places volumes per zone **instance\_ids**string array Instances the volume is mounted on **metadata** array Vendor labels, tags and metadata **raw** Raw data from integration ## Returns [ComputeVolume](https://docs.unified.to/compute/volume/model.md) | Response field | Type | Required | Description | | ------------------------ | ---------------------------------------------------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------- | | id | string | No | Unique identifier for the volume | | created\_at | string (date-time) | No | When the volume was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | updated\_at | string (date-time) | No | When the volume was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | name | string | No | Display name of the volume | | type | enum | No | The kind of volume Values: STANDARD, HIGH\_PERFORMANCE, SHARED, LOCAL, OTHER | | status | enum | No | Normalized volume status Values: CREATING, AVAILABLE, IN\_USE, DELETING, ERROR, OTHER | | size\_mb | number | No | Provisioned size in MiB | | used\_mb | number | No | Used space in MiB | | region\_id | string | No | The region the volume lives in | | availability\_zone | string | No | The availability zone within the region, where the vendor places volumes per zone | | instance\_ids | string\[\] | No | Instances the volume is mounted on | | metadata | [ComputeMetadata](https://docs.unified.to/compute/volume/Create%5Fa%5Fvolume.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 results = await sdk.compute.createComputeVolume({ connectionId, computeVolume: { }, fields: '', raw: '', }); ``` ### Node.js (axios) ```javascript const options = { method: 'POST', url: 'https://api.unified.to/compute/5de520f96e439b002043d8dc/volume', headers: { authorization: 'bearer .....' }, data: undefined, params: { fields: '', raw: '', } }; const results = await axios.request(options); ``` ### Java ```java AsyncHttpClient client = new DefaultAsyncHttpClient(); client.prepare("POST", "https://api.unified.to/compute/5de520f96e439b002043d8dc/volume?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/volume?fields=&raw= req, _ := http.NewRequest("POST", 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/volume?fields=&raw=" headers = { "accept": "application/json", "authorization": "....." } response = requests.post(url, headers=headers) ``` ### PHP ```php $curl = curl_init(); curl_setopt_array($curl, [ CURLOPT_URL => "https://api.unified.to/compute/5de520f96e439b002043d8dc/volume?fields=&raw=", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_HTTPHEADER => [ "accept: application/json", "authorization: ....." ], ]); ``` ### Ruby ```ruby require 'uri' require 'net/http' require 'openssl' url = URI("https://api.unified.to/compute/5de520f96e439b002043d8dc/volume?fields=&raw=") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["accept"] = 'application/json' request["authorization"] = '....' response = http.request(request) puts response.read_body ``` ### cURL ```bash curl --request POST \ --url 'https://api.unified.to/compute/5de520f96e439b002043d8dc/volume?fields=&raw=' \ --header 'accept: application/json' \ --header 'authorization: .....' ```