Resource profiles

Resource profile

Resource profile by ID.

GEThttps://cloud-api.calyptia.com/v1/resource_profiles/{resourceProfileID}

Authorization

userproject

Path parameters

resourceProfileID*string (uuid)

Response

200

OK

Body

application/json

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

JavaScriptCurlPython

const response = await fetch('https://cloud-api.calyptia.com/v1/resource_profiles/{resourceProfileID}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "my-resource-profile",
  "storageSyncFull": false,
  "storageBacklogMemLimit": "1Mi",
  "storageVolumeSize": "2Mi",
  "storageMaxChunksPause": false,
  "cpuLimit": "3Mi",
  "cpuRequest": "4Mi",
  "memoryLimit": "5Mi",
  "memoryRequest": "6Mi",
  "createdAt": "2024-11-21T11:24:30.463Z",
  "updatedAt": "2024-11-21T11:24:30.463Z"
}

Delete resource profile

Delete resource profile by its ID.

DELETEhttps://cloud-api.calyptia.com/v1/resource_profiles/{resourceProfileID}

Authorization

userproject

Path parameters

resourceProfileID*string (uuid)

Response

204

No Content

Request

JavaScriptCurlPython

const response = await fetch('https://cloud-api.calyptia.com/v1/resource_profiles/{resourceProfileID}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Update resource profile

Update resource profile by its ID.

PATCHhttps://cloud-api.calyptia.com/v1/resource_profiles/{resourceProfileID}

Authorization

userproject

Path parameters

resourceProfileID*string (uuid)

Body

application/json

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"

Response

204

No Content

Request

JavaScriptCurlPython

const response = await fetch('https://cloud-api.calyptia.com/v1/resource_profiles/{resourceProfileID}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();