Resource profiles

PreviousCore instance secrets NextAggregator pipelines

Resource profile

get

Resource profile by ID.

Authorizations

Path parameters

resourceProfileIDstring · uuidRequired

Responses

application/json

objectOptional

Resource profile model.

get

GET /v1/resource_profiles/{resourceProfileID} HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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-04-24T04:56:57.896Z",
  "updatedAt": "2025-04-24T04:56:57.896Z"
}

Delete resource profile

delete

Delete resource profile by its ID.

Authorizations

Path parameters

resourceProfileIDstring · uuidRequired

Responses

delete

DELETE /v1/resource_profiles/{resourceProfileID} HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

No content

Update resource profile

patch

Update resource profile by its ID.

Authorizations

Path parameters

resourceProfileIDstring · uuidRequired

Body

Update resource profile request body.

namestring | nullableOptionalDefault: nullExample: my-resource-profile

storageMaxChunksUpinteger · int32 | nullableOptionalDefault: null

storageSyncFullboolean | nullableOptionalDefault: null

storageBacklogMemLimitstring | nullableOptionalDefault: nullExample: 1Mi

storageVolumeSizestring | nullableOptionalDefault: nullExample: 2Mi

storageMaxChunksPauseboolean | nullableOptionalDefault: null

cpuBufferWorkersinteger · int32 | nullableOptionalDefault: null

cpuLimitstring | nullableOptionalDefault: nullExample: 3Mi

cpuRequeststring | nullableOptionalDefault: nullExample: 4Mi

memoryLimitstring | nullableOptionalDefault: nullExample: 5Mi

memoryRequeststring | nullableOptionalDefault: nullExample: 6Mi

Responses

patch

PATCH /v1/resource_profiles/{resourceProfileID} HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 261

{
  "name": "my-resource-profile",
  "storageMaxChunksUp": 1,
  "storageSyncFull": true,
  "storageBacklogMemLimit": "1Mi",
  "storageVolumeSize": "2Mi",
  "storageMaxChunksPause": true,
  "cpuBufferWorkers": 1,
  "cpuLimit": "3Mi",
  "cpuRequest": "4Mi",
  "memoryLimit": "5Mi",
  "memoryRequest": "6Mi"
}

204

No Content

No content