List Endpoint

POST

/user/alert/list

curl --request POST \
  --url https://example.com/user/alert/list \
  --header 'Content-Type: application/json' \
  --header 'X-Tenzir-UserKey: <X-Tenzir-UserKey>' \
  --data '{ "tenant_id": "example" }'

List all configured alerts.

Authorizations

• User Key

Request Body ^required

Media type application/json

ListAlertsRequest

object

tenant_id

required

Tenant Id

string

Example ^generated

{
  "tenant_id": "example"
}

Responses

200

Successful Response

Media type application/json

ListAlertsResponse

object

alerts

required

Alerts

Array<object>

NodeOfflineAlert

object

type

Type

string

default: node_offline

Allowed value: node_offline

id

required

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

{
  "alerts": [
    {
      "type": "node_offline"
    }
  ]
}

403

{"detail": "Invalid API Key"}

404

{"detail": "Dashboard not found"}

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"
    }
  ]
}