ToggleEnabled

Enables or disables an existing alert configuration. The config can be identified by either ID or FQN.

POST /api/alerts/v1/toggle

ToggleEnabled

cURL

curl --request POST \
  --url https://developer.synq.io/api/alerts/v1/toggle \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "identifier": {
    "fqn": "<string>"
  },
  "isEnabled": true
}
'

200

{}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

ToggleEnabledRequest enables or disables an alert configuration. The config can be identified by either ID or FQN.

identifier · fqn · object · required

Identifier for the config to toggle.

fqn

id

Show child attributes

isEnabled · boolean

Whether the alert configuration should be enabled. true = enable the alert, false = disable the alert.

Response

200 - application/json

Success

ToggleEnabledResponse confirms the toggle operation (empty response). Empty response - successful toggle is indicated by HTTP 200 status.