Config sections

Config section

get

/v1/config_sections/{configSectionID}

Authorizations

userproject

Path parameters

configSectionIDstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://cloud-api.calyptia.com/v1/config_sections/{configSectionID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "projectID": "123e4567-e89b-12d3-a456-426614174000",
  "processingRuleID": null,
  "kind": "input",
  "properties": [
    {
      "key": "name",
      "value": "dummy"
    }
  ],
  "createdAt": "2025-03-12T04:17:50.738Z",
  "updatedAt": "2025-03-12T04:17:50.738Z"
}

OK

Delete config section

delete

/v1/config_sections/{configSectionID}

Authorizations

userproject

Path parameters

configSectionIDstring · uuidrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://cloud-api.calyptia.com/v1/config_sections/{configSectionID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

204

204

No body

Deleted

Update config section

patch

/v1/config_sections/{configSectionID}

Authorizations

userproject

Path parameters

configSectionIDstring · uuidrequired

Body

propertiesobject[] | nullable

skipConfigValidationboolean · default: false

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://cloud-api.calyptia.com/v1/config_sections/{configSectionID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "properties": null,
    "skipConfigValidation": false
  }'

200

200

{
  "updatedAt": "2025-03-12T04:17:50.738Z"
}

Updated