Config sections

Config section

GEThttps://cloud-api.calyptia.com/v1/config_sections/{configSectionID}

Authorization

userproject

Path parameters

configSectionID*string (uuid)

Response

200

OK

Body

application/json

id*string (uuid)

projectID*string (uuid)

processingRuleID*nullable string (uuid)

kind*ConfigSectionKind (enum)

inputfilteroutputservice

properties*Pairs (array of Pair (object))

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurl

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

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "projectID": "123e4567-e89b-12d3-a456-426614174000",
  "processingRuleID": "123e4567-e89b-12d3-a456-426614174000",
  "kind": "input",
  "properties": [
    {
      "key": "name",
      "value": "dummy"
    }
  ],
  "createdAt": "2024-07-27T02:55:30.063Z",
  "updatedAt": "2024-07-27T02:55:30.063Z"
}

Delete config section

DELETEhttps://cloud-api.calyptia.com/v1/config_sections/{configSectionID}

Authorization

userproject

Path parameters

configSectionID*string (uuid)

Response

204

Deleted

Request

JavaScriptCurl

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

Update config section

PATCHhttps://cloud-api.calyptia.com/v1/config_sections/{configSectionID}

Authorization

userproject

Path parameters

configSectionID*string (uuid)

Body

application/json

propertiesPairs (array of Pair (object))

skipConfigValidationboolean

Response

200

Updated

Body

application/json

updatedAt*string (date-time)

Request

JavaScriptCurl

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

Response

{
  "updatedAt": "2024-07-27T02:55:30.063Z"
}