Get early access

Retention policies

Retention policies: 5 operations of the ChaosDesk REST API.

Retrieves the collection of RetentionPolicy resources.

GET/api/retention_policies

Responses

  • 200RetentionPolicy collection
  • 403Forbidden

Example request

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

Creates a RetentionPolicy resource.

POST/api/retention_policies

Request body application/json

namestringrequired
action"delete" | "anonymize"
after_monthsinteger
Months since the ticket was closed (last update of a closed ticket).
brandstring | null (iri-reference)
groupstring | null (iri-reference)
activeboolean

Responses

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

Example request

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

Retrieves a RetentionPolicy resource.

GET/api/retention_policies/{id}

Parameters

idstringpathrequired
RetentionPolicy identifier

Responses

  • 200RetentionPolicy resource
  • 403Forbidden
  • 404Not found

Example request

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

Updates the RetentionPolicy resource.

PATCH/api/retention_policies/{id}

Parameters

idstringpathrequired
RetentionPolicy identifier

Request body application/merge-patch+json

namestring
action"delete" | "anonymize"
after_monthsinteger
Months since the ticket was closed (last update of a closed ticket).
brandstring | null (iri-reference)
groupstring | null (iri-reference)
activeboolean

Responses

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

Example request

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

Removes the RetentionPolicy resource.

DELETE/api/retention_policies/{id}

Parameters

idstringpathrequired
RetentionPolicy identifier

Responses

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

Example request

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