Update a volume

Updates an NFS volume.

PATCH /v1/projects/{projectId}/volumes/{id}

Update a volume

cURL

curl --request PATCH \
  --url https://rest.compute.cudo.org/v1/projects/{projectId}/volumes/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dataCenterId": "<string>",
  "sizeGib": 123,
  "commitmentEndTime": "2023-11-07T05:31:56Z",
  "commitmentTerm": "COMMITMENT_TERM_NONE",
  "gibPriceHr": {
    "value": "<string>"
  },
  "state": "VOLUME_STATE_UNSPECIFIED",
  "totalPriceHr": {
    "value": "<string>"
  }
}
'

200

{
  "dataCenterId": "<string>",
  "id": "<string>",
  "projectId": "<string>",
  "sizeGib": 123,
  "commitmentEndTime": "2023-11-07T05:31:56Z",
  "commitmentTerm": "COMMITMENT_TERM_NONE",
  "gibPriceHr": {
    "value": "<string>"
  },
  "nfsPath": "<string>",
  "nfsServer": "<string>",
  "sizeGibUsed": 123,
  "state": "VOLUME_STATE_UNSPECIFIED",
  "totalPriceHr": {
    "value": "<string>"
  }
}

Authorizations

Authorization · string · header · required

API key authentication. API keys should be passed using the format Bearer API_KEY.

Path Parameters

projectId · string · required

id · string · required

Body

application/json

Update volume params

dataCenterId · string · required

sizeGib · integer<int32> · 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.

Show child attributes

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.

Show child attributes

Response

200

application/json

A successful response.

dataCenterId · string · required

id · string · required

projectId · string · required

sizeGib · integer<int32> · 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.

Show child attributes

nfsPath · string · read-only

nfsServer · string · read-only

sizeGibUsed · integer<int32> · read-only

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.

Show child attributes