Volumes

API reference for Volumes on CUDO Compute.

Reference

GET

/v1/projects/{projectId}/volumes

List volumes

List volumes in a project

Path attributes

Name
projectId
Type
string
Description
Name
pageNumber
Type
integer
Description
Name
pageSize
Type
integer
Description

Request

GET

/v1/projects/{projectId}/volumes

    
    curl 'https://rest.compute.cudo.org/v1/projects/{projectId}/volumes' \
-H 'Authorization: bearer <YOUR-API-KEY>'\
-H 'Accept: application/json'

Response

    
    {
  "volumes": [
    {
      "projectId": "string",
      "id": "string",
      "dataCenterId": "string",
      "sizeGib": "integer",
      "sizeGibUsed": "integer",
      "nfsServer": "string",
      "nfsPath": "string",
      "state": "string",
      "gibPriceHr": {
        "value": "string"
      },
      "totalPriceHr": {
        "value": "string"
      },
      "commitmentTerm": "string",
      "commitmentEndTime": "string"
    }
  ],
  "totalCount": "integer",
  "pageNumber": "integer",
  "pageSize": "integer"
}

GET

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

Get a volume

Get the details of a volume

Path attributes

Name
projectId
Type
string
Description
Name
id
Type
string
Description

Request

GET

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

    
    curl 'https://rest.compute.cudo.org/v1/projects/{projectId}/volumes/{id}' \
-H 'Authorization: bearer <YOUR-API-KEY>'\
-H 'Accept: application/json'

Response

    
    {
  "projectId": "string",
  "id": "string",
  "dataCenterId": "string",
  "sizeGib": "integer",
  "sizeGibUsed": "integer",
  "nfsServer": "string",
  "nfsPath": "string",
  "state": "string",
  "gibPriceHr": {
    "value": "string"
  },
  "totalPriceHr": {
    "value": "string"
  },
  "commitmentTerm": "string",
  "commitmentEndTime": "string"
}

DELETE

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

Delete a volume

Delete a volume from a project.

Path attributes

Name
projectId
Type
string
Description
Name
id
Type
string
Description

Request

DELETE

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

    
    curl 'https://rest.compute.cudo.org/v1/projects/{projectId}/volumes/{id}' \
-H 'Authorization: bearer <YOUR-API-KEY>'\
-H 'Accept: application/json'

Response

{}

POST

/v1/projects/{volume.projectId}/volumes

Create a volume

Order a volume for a project

Body attributes

Name
id
Type
string
Description
Name
dataCenterId
Type
string
Description
Name
sizeGib
Type
integer
Description
Name
commitmentTerm
Type
string
Description
Name
commitmentEndTime
Type
string
Description

Path attributes

Name
volume.projectId
Type
string
Description

Request

POST

/v1/projects/{volume.projectId}/volumes

    
    curl 'https://rest.compute.cudo.org/v1/projects/{volume.projectId}/volumes' \
-H 'Authorization: bearer <YOUR-API-KEY>'\
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
    "id": "string",
    "dataCenterId": "string",
    "sizeGib": "integer",
    "commitmentTerm": "string",
    "commitmentEndTime": "string"
}'

Response

    
    {
  "projectId": "string",
  "id": "string",
  "dataCenterId": "string",
  "sizeGib": "integer",
  "sizeGibUsed": "integer",
  "nfsServer": "string",
  "nfsPath": "string",
  "state": "string",
  "gibPriceHr": {
    "value": "string"
  },
  "totalPriceHr": {
    "value": "string"
  },
  "commitmentTerm": "string",
  "commitmentEndTime": "string"
}

PATCH

/v1/projects/{volume.projectId}/volumes/{volume.id}

Update a volume

Body attributes

Name
dataCenterId
Type
string
Description
Name
sizeGib
Type
integer
Description
Name
commitmentTerm
Type
string
Description
Name
commitmentEndTime
Type
string
Description

Path attributes

Name
volume.projectId
Type
string
Description
Name
volume.id
Type
string
Description

Request

PATCH

/v1/projects/{volume.projectId}/volumes/{volume.id}

    
    curl 'https://rest.compute.cudo.org/v1/projects/{volume.projectId}/volumes/{volume.id}' \
-H 'Authorization: bearer <YOUR-API-KEY>'\
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
    "dataCenterId": "string",
    "sizeGib": "integer",
    "commitmentTerm": "string",
    "commitmentEndTime": "string"
}'

Response

    
    {
  "projectId": "string",
  "id": "string",
  "dataCenterId": "string",
  "sizeGib": "integer",
  "sizeGibUsed": "integer",
  "nfsServer": "string",
  "nfsPath": "string",
  "state": "string",
  "gibPriceHr": {
    "value": "string"
  },
  "totalPriceHr": {
    "value": "string"
  },
  "commitmentTerm": "string",
  "commitmentEndTime": "string"
}

API referenceVirtual machines

DocsSupply