Get early access

Automations

Automations: 5 operations of the ChaosDesk REST API.

Retrieves the collection of Automation resources.

GET/api/automations

Responses

  • 200Automation collection
  • 403Forbidden

Example request

curl -X GET "https://yourcompany.chaosdesk.io/api/automations" \
  -H "Authorization: Bearer $CHAOSDESK_TOKEN" \
  -H "Accept: application/json"

Creates a Automation resource.

POST/api/automations

Request body application/json

conditionsobject
actionsobject[]
titlestringrequired
descriptionstring | null
activeboolean
positioninteger

Responses

  • 201Automation resource created
  • 400Invalid input
  • 403Forbidden
  • 422An error occurred

Example request

curl -X POST "https://yourcompany.chaosdesk.io/api/automations" \
  -H "Authorization: Bearer $CHAOSDESK_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"title":"string"}'

Retrieves a Automation resource.

GET/api/automations/{id}

Parameters

idstringpathrequired
Automation identifier

Responses

  • 200Automation resource
  • 403Forbidden
  • 404Not found

Example request

curl -X GET "https://yourcompany.chaosdesk.io/api/automations/{id}" \
  -H "Authorization: Bearer $CHAOSDESK_TOKEN" \
  -H "Accept: application/json"

Updates the Automation resource.

PATCH/api/automations/{id}

Parameters

idstringpathrequired
Automation identifier

Request body application/merge-patch+json

conditionsobject
actionsobject[]
titlestring
descriptionstring | null
activeboolean
positioninteger

Responses

  • 200Automation resource updated
  • 400Invalid input
  • 403Forbidden
  • 404Not found
  • 422An error occurred

Example request

curl -X PATCH "https://yourcompany.chaosdesk.io/api/automations/{id}" \
  -H "Authorization: Bearer $CHAOSDESK_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/merge-patch+json" \
  -d '{"conditions":"string","actions":"string"}'

Removes the Automation resource.

DELETE/api/automations/{id}

Parameters

idstringpathrequired
Automation identifier

Responses

  • 204Automation resource deleted
  • 403Forbidden
  • 404Not found

Example request

curl -X DELETE "https://yourcompany.chaosdesk.io/api/automations/{id}" \
  -H "Authorization: Bearer $CHAOSDESK_TOKEN" \
  -H "Accept: application/json"