Resource profiles

PreviousCore instance secrets NextAggregator pipelines

Resource profile

Resource profile by ID.

get

/v1/resource_profiles/{resourceProfileID}

Authorizations

Path parameters

resourceProfileIDstring uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

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-02-09T20:25:51.673Z",
  "updatedAt": "2025-02-09T20:25:51.673Z"
}

Delete resource profile

Delete resource profile by its ID.

delete

/v1/resource_profiles/{resourceProfileID}

Authorizations

Path parameters

resourceProfileIDstring uuidrequired

Responses

cURL

JavaScript

Python

HTTP

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

204

No body

No Content

Update resource profile

Update resource profile by its ID.

patch

/v1/resource_profiles/{resourceProfileID}

Authorizations

Path parameters

resourceProfileIDstring uuidrequired

Body

namenullable string

Example: my-resource-profile

storageMaxChunksUpnullable integer int32

storageSyncFullnullable boolean

storageBacklogMemLimitnullable string

Example: 1Mi

storageVolumeSizenullable string

Example: 2Mi

storageMaxChunksPausenullable boolean

cpuBufferWorkersnullable integer int32

cpuLimitnullable string

Example: 3Mi

cpuRequestnullable string

Example: 4Mi

memoryLimitnullable string

Example: 5Mi

memoryRequestnullable string

Example: 6Mi

Responses

cURL

JavaScript

Python

HTTP

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

No body

No Content