Uptime API › Weekly summary
Turn the weekly summary on or off
Turns the weekly summary on or off for the whole organization.
Only an owner or administrator signed in to EvoHub can do this. An API key always gets 403, whatever its scopes or role.
Requires the uptime:monitor:read scope, and a person who is an
owner or administrator.
Authorization
Request body required
enabledboolean required
Responses
200
The weekly summary settings, as the caller sees them.
dataDigestSettingsShow DigestSettings properties
availableboolean requiredWhether EvoHub sends the weekly summary at all. Whenfalse, nothing is sent whatever the other fields say.enabledboolean requiredWhether the organization has it on.subscribedboolean requiredWhether the caller receives it, if they are an owner or administrator.can_manageboolean requiredWhether the caller may turn it on or off and send a preview. Alwaysfalsefor an API key.
400
The body is not {"enabled": true|false} (VALIDATION_ERROR).
errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
401
No API key was sent, or it is unknown, revoked or expired (UNAUTHORIZED).
errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
403
The caller is not an owner or administrator signed in as a person, or lacks uptime:monitor:read (FORBIDDEN).
errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
429
Too many requests (RATE_LIMITED). Wait for Retry-After seconds.
Retry-AfterintegerSeconds to wait before retrying.
errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
500
Something went wrong on EvoHub's side (INTERNAL_ERROR). Retry later.
errorobject requiredcodestring requiredmessagestring requiredrequest_idstring
Example request
curl -X PUT 'https://evohub.io/api/v1/uptime-digest' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
"enabled": true
}'