Update an error group. Mainly used for archiving error groups.

Update an error group. Mainly used for archiving error groups.

PATCH /v1/error-groups/{id}

Try it

Update an error group. Mainly used for archiving error groups.

cURL

curl --request PATCH \
  --url https://api.checklyhq.com/v1/error-groups/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "archiveForEver": true,
  "archivedUntilNextEvent": true
}
'

200

{
  "id": "<string>",
  "checkId": "<string>",
  "errorHash": "<string>",
  "rawErrorMessage": "<string>",
  "cleanedErrorMessage": "<string>",
  "firstSeen": "2023-12-25",
  "lastSeen": "2023-12-25",
  "archivedUntilNextEvent": true
}

Authorizations

Authorization · string · header · required

The Checkly Public API uses API keys to authenticate requests. You can get the API Key here. Your API key is like a password: keep it secure! Authentication to the API is performed using the Bearer auth method in the Authorization header and using the account ID. For example, set Authorization header while using cURL: curl -H "Authorization: Bearer [apiKey]" "X-Checkly-Account: [accountId]"

Headers

x-checkly-account · string

Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general

Body

application/json

archiveForEver · boolean

archivedUntilNextEvent · boolean

Response

200

application/json

Successful

id · string · required

checkId · string · required

errorHash · string · required

The hash of the cleaned error message for quicker deduplication.

rawErrorMessage · string | null · required

The raw error message as recorded in a check result.

cleanedErrorMessage · string · required

The cleaned and sanitized error message used for hashing and grouping.

firstSeen · string<date> · required

lastSeen · string<date> · required

archivedUntilNextEvent · boolean · required