Resource profiles

Resource profile

get

Resource profile by ID.

Authorizations

userproject

Path parameters

resourceProfileIDstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://cloud-api.calyptia.com/v1/resource_profiles/{resourceProfileID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "my-resource-profile",
  "storageMaxChunksUp": 1,
  "storageSyncFull": true,
  "storageBacklogMemLimit": "1Mi",
  "storageVolumeSize": "2Mi",
  "storageMaxChunksPause": true,
  "cpuBufferWorkers": 1,
  "cpuLimit": "3Mi",
  "cpuRequest": "4Mi",
  "memoryLimit": "5Mi",
  "memoryRequest": "6Mi",
  "createdAt": "2025-03-20T06:34:22.375Z",
  "updatedAt": "2025-03-20T06:34:22.375Z"
}

OK

Delete resource profile

delete

Delete resource profile by its ID.

Authorizations

userproject

Path parameters

resourceProfileIDstring · uuidrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://cloud-api.calyptia.com/v1/resource_profiles/{resourceProfileID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

204

204

No body

No Content

Update resource profile

patch

Update resource profile by its ID.

Authorizations

userproject

Path parameters

resourceProfileIDstring · uuidrequired

Body

namestring | nullable

Example: my-resource-profile

storageMaxChunksUpinteger · int32 | nullable

storageSyncFullboolean | nullable

storageBacklogMemLimitstring | nullable

Example: 1Mi

storageVolumeSizestring | nullable

Example: 2Mi

storageMaxChunksPauseboolean | nullable

cpuBufferWorkersinteger · int32 | nullable

cpuLimitstring | nullable

Example: 3Mi

cpuRequeststring | nullable

Example: 4Mi

memoryLimitstring | nullable

Example: 5Mi

memoryRequeststring | nullable

Example: 6Mi

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://cloud-api.calyptia.com/v1/resource_profiles/{resourceProfileID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "my-resource-profile",
    "storageMaxChunksUp": null,
    "storageSyncFull": null,
    "storageBacklogMemLimit": "1Mi",
    "storageVolumeSize": "2Mi",
    "storageMaxChunksPause": null,
    "cpuBufferWorkers": null,
    "cpuLimit": "3Mi",
    "cpuRequest": "4Mi",
    "memoryLimit": "5Mi",
    "memoryRequest": "6Mi"
  }'

204

204

No body

No Content