Skip to content

Add Endpoint

POST
/user/alert/add
 
curl --request POST \
  --url https://example.com/user/alert/add \
  --header 'Content-Type: application/json' \
  --header 'X-Tenzir-UserKey: <X-Tenzir-UserKey>' \
  --data '{ "tenant_id": "example", "node_id": "example", "duration": 1, "webhook_url": "example", "webhook_body": "example" }'

Add a new alert

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
AddAlertRequest
object
tenant_id
required
Tenant Id
string
node_id
required
Node Id
string
duration
required
Duration
integer
webhook_url
required
Webhook Url
string
webhook_body
required
Webhook Body
string
Example generated
{
  "tenant_id": "example",
  "node_id": "example",
  "duration": 1,
  "webhook_url": "example",
  "webhook_body": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
AddAlertResponse
object
alert_id
required
Alert Id
string
Example generated
{
  "alert_id": "example"
}

403

Section titled “403 ”

{"detail": "Invalid API Key"}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}