Ctrl+K

Set consumer pause state (admin)

put/api/notifications/v1/admin/consumers/pause

Sets the pause state for all event consumers. Set paused=true to pause, paused=false to unpause. Protected by the NCC-Failover-Switch-Enabled feature flag.

Request Body

paused boolean required

200 Response

success boolean required
Whether the operation was successful
Example: true
message string required
Descriptive message about the operation result
Example: Consumers successfully paused
paused boolean required
Current pause state of consumers
Example: true

400 Response

name string required
Error code
Allowed values: ValidationFailed IllegalArgument BadRequest DataIntegrityError NotImplementedError RETRIGGER_RATE_LIMITED USER_CREATION_FAILED USER_FALLBACK_FAILED
error string required
Human-readable error message
status integer <int32>required
HTTP status code
Allowed value: 400

403 Response

name string required
Error code
Allowed value: AccessDenied
error string required
Human-readable error message
status integer <int32>required
HTTP status code
Allowed value: 403

500 Response

name string required
Error code
Allowed values: UnexpectedError ThirdPartyError DatabaseError USER_FALLBACK_TIMEOUT
error string required
Human-readable error message
status integer <int32>required
HTTP status code
Allowed value: 500