Config sections

Config section

GEThttps://cloud-api.calyptia.com/v1/config_sections/{configSectionID}
Authorization
Path parameters
configSectionID*string (uuid)
Response

OK

Body
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
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-12-02T17:09:16.772Z",
  "updatedAt": "2024-12-02T17:09:16.772Z"
}

Delete config section

DELETEhttps://cloud-api.calyptia.com/v1/config_sections/{configSectionID}
Authorization
Path parameters
configSectionID*string (uuid)
Response

Deleted

Request
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
Path parameters
configSectionID*string (uuid)
Body
propertiesPairs (array of Pair (object))
skipConfigValidationboolean
Response

Updated

Body
updatedAt*string (date-time)
Request
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-12-02T17:09:16.772Z"
}