Resource profiles

PreviousPing NextPipelines

Resource profiles

Resource profiles from a core instance.

get

/v1/aggregators/{aggregatorID}/resource_profiles

Authorizations

Path parameters

aggregatorIDstring · uuidrequired

Query parameters

lastinteger

Last tokens.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://cloud-api.calyptia.com/v1/aggregators/{aggregatorID}/resource_profiles' \
  --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-03-12T04:23:57.805Z",
    "updatedAt": "2025-03-12T04:23:57.805Z"
  }
]

Create resource profile

Create resource profile within a core instance. A resource profile is a specification of a resource used during the deployment of a pipeline. By default, when you setup a core instance, Calyptia Cloud will generate 3 resource profiles for you:

high-performance-guaranteed-delivery.
high-performance-optimal-throughput.
best-effort-low-resource.

post

/v1/aggregators/{aggregatorID}/resource_profiles

Authorizations

Path parameters

aggregatorIDstring · uuidrequired

Body

namestringrequired

Example: my-resource-profile

storageMaxChunksUpinteger · int32required

storageSyncFullbooleanrequired

storageBacklogMemLimitstringrequired

Example: 1Mi

storageVolumeSizestringrequired

Example: 2Mi

storageMaxChunksPausebooleanrequired

cpuBufferWorkersinteger · int32required

cpuLimitstringrequired

Example: 3Mi

cpuRequeststringrequired

Example: 4Mi

memoryLimitstringrequired

Example: 5Mi

memoryRequeststringrequired

Example: 6Mi