Object Storage

API reference for Object Storage on CUDO Compute.

Reference

POST

/v1/projects/{projectId}/object-storage/activate/{dataCenterId}

Allow the use of S3 compatible storage in a project

Path attributes

Name
projectId
Type
string
Description
Name
dataCenterId
Type
string
Description

Request

POST

/v1/projects/{projectId}/object-storage/activate/{dataCenterId}

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

Response

{}

GET

/v1/projects/{projectId}/object-storage/buckets

List buckets

Path attributes

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

Request

GET

/v1/projects/{projectId}/object-storage/buckets

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

Response

{
  "buckets": [
    {
      "projectId": "string",
      "dataCenterId": "string",
      "id": "string",
      "endpoint": "string",
      "objectCount": "string",
      "sizeBytes": "string",
      "billableBytes": "string",
      "storageGibPriceHr": {
        "value": "string"
      }
    }
  ],
  "totalCount": "integer",
  "pageNumber": "integer",
  "pageSize": "integer"
}

GET

/v1/projects/{projectId}/object-storage/buckets/{dataCenterId}/{id}

Get details for a bucket

Path attributes

Name
projectId
Type
string
Description
Name
dataCenterId
Type
string
Description
Name
id
Type
string
Description

Request

GET

/v1/projects/{projectId}/object-storage/buckets/{dataCenterId}/{id}

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

Response

{
  "projectId": "string",
  "dataCenterId": "string",
  "id": "string",
  "endpoint": "string",
  "objectCount": "string",
  "sizeBytes": "string",
  "billableBytes": "string",
  "storageGibPriceHr": {
    "value": "string"
  }
}

GET

/v1/projects/{projectId}/object-storage/session-key/{dataCenterId}

Generate temporary key for storage bucket access

Path attributes

Name
projectId
Type
string
Description
Name
dataCenterId
Type
string
Description

Request

GET

/v1/projects/{projectId}/object-storage/session-key/{dataCenterId}

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

Response

{
  "sessionName": "string",
  "accessKey": "string",
  "secretKey": "string",
  "sessionToken": "string",
  "endpoint": "string"
}

GET

/v1/projects/{projectId}/object-storage/users

List storage users

Path attributes

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

Request

GET

/v1/projects/{projectId}/object-storage/users

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

Response

{
  "users": [
    {
      "projectId": "string",
      "dataCenterId": "string",
      "id": "string",
      "keys": [
        {
          "accessKey": "string",
          "secretKey": "string"
        }
      ],
      "createBy": "string",
      "createTime": "string"
    }
  ],
  "totalCount": "integer",
  "pageNumber": "integer",
  "pageSize": "integer"
}

POST

/v1/projects/{projectId}/object-storage/users/{dataCenterId}

Create user that stores keys for storage buckets

Body attributes

Name
id
Type
string
Description

Path attributes

Name
projectId
Type
string
Description
Name
dataCenterId
Type
string
Description

Request

POST

/v1/projects/{projectId}/object-storage/users/{dataCenterId}

curl 'https://rest.compute.cudo.org/v1/projects/{projectId}/object-storage/users/{dataCenterId}' \
-H 'Authorization: bearer <YOUR-API-KEY>'\
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
    "id": "string"
}'

Response

{
  "projectId": "string",
  "dataCenterId": "string",
  "id": "string",
  "keys": [
    {
      "accessKey": "string",
      "secretKey": "string"
    }
  ],
  "createBy": "string",
  "createTime": "string"
}

DELETE

/v1/projects/{projectId}/object-storage/users/{dataCenterId}/{id}

Delete object storage user

Path attributes

Name
projectId
Type
string
Description
Name
dataCenterId
Type
string
Description
Name
id
Type
string
Description

Request

DELETE

/v1/projects/{projectId}/object-storage/users/{dataCenterId}/{id}

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

Response

{}

POST

/v1/projects/{projectId}/object-storage/users/{dataCenterId}/{id}

Generate access key for storage buckets

Path attributes

Name
projectId
Type
string
Description
Name
dataCenterId
Type
string
Description
Name
id
Type
string
Description

Request

POST

/v1/projects/{projectId}/object-storage/users/{dataCenterId}/{id}

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

Response

{
  "accessKey": "string",
  "secretKey": "string"
}

DELETE

/v1/projects/{projectId}/object-storage/users/{dataCenterId}/{id}/keys/{accessKey}

Delete object storage user key

Path attributes

Name
projectId
Type
string
Description
Name
dataCenterId
Type
string
Description
Name
id
Type
string
Description
Name
accessKey
Type
string
Description

Request

DELETE

/v1/projects/{projectId}/object-storage/users/{dataCenterId}/{id}/keys/{accessKey}

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

Response

{}

GET

/v1/projects/{projectId}/object-storage/users/{dataCenterId}/{userId}

Get details about an object storage user

Path attributes

Name
projectId
Type
string
Description
Name
dataCenterId
Type
string
Description
Name
userId
Type
string
Description

Request

GET

/v1/projects/{projectId}/object-storage/users/{dataCenterId}/{userId}

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

Response

{
  "projectId": "string",
  "dataCenterId": "string",
  "id": "string",
  "keys": [
    {
      "accessKey": "string",
      "secretKey": "string"
    }
  ],
  "createBy": "string",
  "createTime": "string"
}

Rest ApiNetworks

Rest ApiPermissions