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

storageMaxChunksUp*integer (int32)

storageSyncFull*boolean

storageBacklogMemLimit*string

storageVolumeSize*string

storageMaxChunksPause*boolean

cpuBufferWorkers*integer (int32)

cpuLimit*string

cpuRequest*string

memoryLimit*string

memoryRequest*string

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurl

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

{
  "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-04-20T13:34:47.115Z",
  "updatedAt": "2024-04-20T13:34:47.115Z"
}

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

JavaScriptCurl

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

storageMaxChunksUpnullable integer (int32)

storageSyncFullnullable boolean

storageBacklogMemLimitnullable string

storageVolumeSizenullable string

storageMaxChunksPausenullable boolean

cpuBufferWorkersnullable integer (int32)

cpuLimitnullable string

cpuRequestnullable string

memoryLimitnullable string

memoryRequestnullable string

Response

204

No Content

Request

JavaScriptCurl

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();