Skip to main content
GET
/
v1
/
projects
/
{projectId}
/
volumes
/
{id}
Get a volume
curl --request GET \
  --url https://rest.compute.cudo.org/v1/projects/{projectId}/volumes/{id} \
  --header 'Authorization: <api-key>'
{
  "commitmentEndTime": "2023-11-07T05:31:56Z",
  "commitmentTerm": "COMMITMENT_TERM_NONE",
  "dataCenterId": "<string>",
  "gibPriceHr": {
    "value": "<string>"
  },
  "id": "<string>",
  "nfsPath": "<string>",
  "nfsServer": "<string>",
  "projectId": "<string>",
  "sizeGib": 123,
  "sizeGibUsed": 123,
  "state": "VOLUME_STATE_UNSPECIFIED",
  "totalPriceHr": {
    "value": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer HTTP authentication. Allowed headers-- Authorization: Bearer <api_key>

Path Parameters

​
projectId
string
required
​
id
string
required

Response

A successful response.

​
dataCenterId
string
required
​
id
string
required
​
projectId
string
required
​
sizeGib
integer
required
​
commitmentEndTime
string<date-time>
​
commitmentTerm
enum<string>
default:COMMITMENT_TERM_NONE
Available options:
COMMITMENT_TERM_NONE,
COMMITMENT_TERM_1_MONTH,
COMMITMENT_TERM_3_MONTHS,
COMMITMENT_TERM_6_MONTHS,
COMMITMENT_TERM_12_MONTHS,
COMMITMENT_TERM_24_MONTHS,
COMMITMENT_TERM_36_MONTHS,
COMMITMENT_TERM_60_MONTHS
​
gibPriceHr
object

A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal.

​
nfsPath
string
​
nfsServer
string
​
sizeGibUsed
integer
​
state
enum<string>
default:VOLUME_STATE_UNSPECIFIED
Available options:
VOLUME_STATE_UNSPECIFIED,
CREATING,
ACTIVE,
UPDATING,
DELETING,
FAILED
​
totalPriceHr
object

A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal.