Support PortalCalyptia CoreContact Us

Resource profiles

Resource profiles

get

Resource profiles from a core instance.

Authorizations
Path parameters
aggregatorIDstring · uuidRequired
Query parameters
lastintegerOptional

Last tokens.

Responses
200
OK
application/json
get
GET /v1/aggregators/{aggregatorID}/resource_profiles HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

[
  {
    "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-06-27T16:44:37.044Z",
    "updatedAt": "2025-06-27T16:44:37.044Z"
  }
]

Create resource profile

post

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.
Authorizations
Path parameters
aggregatorIDstring · uuidRequired
Body

Create resource profile request body.

namestringRequiredExample: my-resource-profile
storageMaxChunksUpinteger · int32Required
storageSyncFullbooleanRequired
storageBacklogMemLimitstringRequiredExample: 1Mi
storageVolumeSizestringRequiredExample: 2Mi
storageMaxChunksPausebooleanRequired
cpuBufferWorkersinteger · int32Required
cpuLimitstringRequiredExample: 3Mi
cpuRequeststringRequiredExample: 4Mi
memoryLimitstringRequiredExample: 5Mi
memoryRequeststringRequiredExample: 6Mi
Responses
201
Created
application/json
post
POST /v1/aggregators/{aggregatorID}/resource_profiles 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"
}
201

Created

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-06-27T16:44:37.044Z"
}
PreviousPingNextPipelines