Get early access

Groups

Groups: 5 operations of the ChaosDesk REST API.

Retrieves the collection of Group resources.

GET/api/groups

Responses

  • 200Group collection
  • 403Forbidden

Example request

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

Creates a Group resource.

POST/api/groups

Request body application/json

namestringrequired
descriptionstring | null
is_defaultboolean
is_privateboolean
Private group (Zendesk): its tickets are visible only to members, admins included.
membersstring (iri-reference)[]

Responses

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

Example request

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

Retrieves a Group resource.

GET/api/groups/{id}

Parameters

idstringpathrequired
Group identifier

Responses

  • 200Group resource
  • 403Forbidden
  • 404Not found

Example request

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

Updates the Group resource.

PATCH/api/groups/{id}

Parameters

idstringpathrequired
Group identifier

Request body application/merge-patch+json

namestring
descriptionstring | null
is_defaultboolean
is_privateboolean
Private group (Zendesk): its tickets are visible only to members, admins included.
membersstring (iri-reference)[]

Responses

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

Example request

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

Removes the Group resource.

DELETE/api/groups/{id}

Parameters

idstringpathrequired
Group identifier

Responses

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

Example request

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