Support PortalCalyptia CoreContact Us

Resource profiles

Resource profiles

Resource profiles from a core instance.

GEThttps://cloud-api.calyptia.com/v1/aggregators/{aggregatorID}/resource_profiles
Authorization
Path parameters
aggregatorID*string (uuid)
Query parameters
Response

OK

Body
id*string (uuid)
name*string
Example: "my-resource-profile"
storageMaxChunksUp*integer (int32)
storageSyncFull*boolean
storageBacklogMemLimit*string
Example: "1Mi"
storageVolumeSize*string
Example: "2Mi"
storageMaxChunksPause*boolean
cpuBufferWorkers*integer (int32)
cpuLimit*string
Example: "3Mi"
cpuRequest*string
Example: "4Mi"
memoryLimit*string
Example: "5Mi"
memoryRequest*string
Example: "6Mi"
createdAt*string (date-time)
updatedAt*string (date-time)
Request
const response = await fetch('https://cloud-api.calyptia.com/v1/aggregators/{aggregatorID}/resource_profiles', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();
Response
[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "my-resource-profile",
    "storageMaxChunksUp": 0,
    "storageSyncFull": false,
    "storageBacklogMemLimit": "1Mi",
    "storageVolumeSize": "2Mi",
    "storageMaxChunksPause": false,
    "cpuBufferWorkers": 0,
    "cpuLimit": "3Mi",
    "cpuRequest": "4Mi",
    "memoryLimit": "5Mi",
    "memoryRequest": "6Mi",
    "createdAt": "2025-01-15T06:18:00.771Z",
    "updatedAt": "2025-01-15T06:18:00.771Z"
  }
]

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.
POSThttps://cloud-api.calyptia.com/v1/aggregators/{aggregatorID}/resource_profiles
Authorization
Path parameters
aggregatorID*string (uuid)
Body
name*string
Example: "my-resource-profile"
storageMaxChunksUp*integer (int32)
storageSyncFull*boolean
storageBacklogMemLimit*string
Example: "1Mi"
storageVolumeSize*string
Example: "2Mi"
storageMaxChunksPause*boolean
cpuBufferWorkers*integer (int32)
cpuLimit*string
Example: "3Mi"
cpuRequest*string
Example: "4Mi"
memoryLimit*string
Example: "5Mi"
memoryRequest*string
Example: "6Mi"
Response

Created

Body
id*string (uuid)
createdAt*string (date-time)
Request
const response = await fetch('https://cloud-api.calyptia.com/v1/aggregators/{aggregatorID}/resource_profiles', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "my-resource-profile",
      "storageMaxChunksUp": 0,
      "storageSyncFull": false,
      "storageBacklogMemLimit": "1Mi",
      "storageVolumeSize": "2Mi",
      "storageMaxChunksPause": false,
      "cpuBufferWorkers": 0,
      "cpuLimit": "3Mi",
      "cpuRequest": "4Mi",
      "memoryLimit": "5Mi",
      "memoryRequest": "6Mi"
    }),
});
const data = await response.json();
Response
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-15T06:18:00.771Z"
}
PreviousPingNextPipelines