Skip to main content

Notifications API 1.5.0

Notification events and notification event settings.

Base path: https://{controller_ip}/api/v1. API description version: 1.5.0.

Examples use placeholder values for passwords, tokens, UUIDs, addresses and secrets. Replace them with values from your controller before sending requests.

Section methods​

MethodPath
GET/notification_events/
GET/notification_events/count
GET/notification_events/error_codes
GET/notification_events/types
GET/notification_events/user_defined_notifications/
GET/notification_events/user_defined_notifications/{uuid}
GET/notification_events/{uuid}
POST/notification_events/user_defined/
POST/notification_events/user_defined_notifications/
PUT/notification_events/user_defined/{uuid}
PUT/notification_events/user_defined_notifications/{uuid}
DELETE/notification_events/user_defined/{uuid}
DELETE/notification_events/user_defined_notifications/{uuid}

GET /notification_events/​

Section: Notifications.

Returns data for the notifications endpoint /notification_events/.

Request example​

curl -k -X GET "https://{controller_ip}/api/v1/notification_events/" \
  -H "Authorization: Bearer <token>"

Response command example​

curl -k -sS -X GET "https://{controller_ip}/api/v1/notification_events/" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "data": [],
  "meta": {
    "api_version": "1.5.0",
    "path": "/notification_events/"
  }
}

GET /notification_events/count​

Section: Notifications.

Returns a count for the notifications endpoint /notification_events/count.

Request example​

curl -k -X GET "https://{controller_ip}/api/v1/notification_events/count" \
  -H "Authorization: Bearer <token>"

Response command example​

curl -k -sS -X GET "https://{controller_ip}/api/v1/notification_events/count" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "count": 12
}

GET /notification_events/error_codes​

Section: Notifications.

Returns data for the notifications endpoint /notification_events/error_codes.

Request example​

curl -k -X GET "https://{controller_ip}/api/v1/notification_events/error_codes" \
  -H "Authorization: Bearer <token>"

Response command example​

curl -k -sS -X GET "https://{controller_ip}/api/v1/notification_events/error_codes" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "data": [],
  "meta": {
    "api_version": "1.5.0",
    "path": "/notification_events/error_codes"
  }
}

GET /notification_events/types​

Section: Notifications.

Returns reference values for the notifications endpoint /notification_events/types.

Request example​

curl -k -X GET "https://{controller_ip}/api/v1/notification_events/types" \
  -H "Authorization: Bearer <token>"

Response command example​

curl -k -sS -X GET "https://{controller_ip}/api/v1/notification_events/types" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "data": [],
  "meta": {
    "api_version": "1.5.0",
    "path": "/notification_events/types"
  }
}

GET /notification_events/user_defined_notifications/​

Section: Notifications.

Returns data for the notifications endpoint /notification_events/user_defined_notifications/.

Request example​

curl -k -X GET "https://{controller_ip}/api/v1/notification_events/user_defined_notifications/" \
  -H "Authorization: Bearer <token>"

Response command example​

curl -k -sS -X GET "https://{controller_ip}/api/v1/notification_events/user_defined_notifications/" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "data": [],
  "meta": {
    "api_version": "1.5.0",
    "path": "/notification_events/user_defined_notifications/"
  }
}

GET /notification_events/user_defined_notifications/{uuid}​

Section: Notifications.

Returns data for the notifications endpoint /notification_events/user_defined_notifications/{uuid}.

Request example​

curl -k -X GET "https://{controller_ip}/api/v1/notification_events/user_defined_notifications/{uuid}" \
  -H "Authorization: Bearer <token>"

Response command example​

curl -k -sS -X GET "https://{controller_ip}/api/v1/notification_events/user_defined_notifications/{uuid}" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "data": [],
  "meta": {
    "api_version": "1.5.0",
    "path": "/notification_events/user_defined_notifications/{uuid}"
  }
}

GET /notification_events/{uuid}​

Section: Notifications.

Returns data for the notifications endpoint /notification_events/{uuid}.

Request example​

curl -k -X GET "https://{controller_ip}/api/v1/notification_events/{uuid}" \
  -H "Authorization: Bearer <token>"

Response command example​

curl -k -sS -X GET "https://{controller_ip}/api/v1/notification_events/{uuid}" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "data": [],
  "meta": {
    "api_version": "1.5.0",
    "path": "/notification_events/{uuid}"
  }
}

POST /notification_events/user_defined/​

Section: Notifications.

Creates a record or starts an operation for the notifications endpoint /notification_events/user_defined/.

Request example​

curl -k -X POST "https://{controller_ip}/api/v1/notification_events/user_defined/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "type": "custom_notification",
  "message": "External notification"
}'

Request body example​

{
  "type": "custom_notification",
  "message": "External notification"
}

Response command example​

curl -k -sS -X POST "https://{controller_ip}/api/v1/notification_events/user_defined/" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "status": "success",
  "data": {
    "uuid": "<uuid>"
  }
}

POST /notification_events/user_defined_notifications/​

Section: Notifications.

Creates a record or starts an operation for the notifications endpoint /notification_events/user_defined_notifications/.

Request example​

curl -k -X POST "https://{controller_ip}/api/v1/notification_events/user_defined_notifications/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "type": "custom_notification",
  "message": "External notification"
}'

Request body example​

{
  "type": "custom_notification",
  "message": "External notification"
}

Response command example​

curl -k -sS -X POST "https://{controller_ip}/api/v1/notification_events/user_defined_notifications/" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "status": "success",
  "data": {
    "uuid": "<uuid>"
  }
}

PUT /notification_events/user_defined/{uuid}​

Section: Notifications.

Updates data for the notifications endpoint /notification_events/user_defined/{uuid}.

Request example​

curl -k -X PUT "https://{controller_ip}/api/v1/notification_events/user_defined/{uuid}" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "type": "custom_notification",
  "message": "External notification"
}'

Request body example​

{
  "type": "custom_notification",
  "message": "External notification"
}

Response command example​

curl -k -sS -X PUT "https://{controller_ip}/api/v1/notification_events/user_defined/{uuid}" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "status": "success",
  "data": {
    "uuid": "<uuid>"
  }
}

PUT /notification_events/user_defined_notifications/{uuid}​

Section: Notifications.

Updates data for the notifications endpoint /notification_events/user_defined_notifications/{uuid}.

Request example​

curl -k -X PUT "https://{controller_ip}/api/v1/notification_events/user_defined_notifications/{uuid}" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "type": "custom_notification",
  "message": "External notification"
}'

Request body example​

{
  "type": "custom_notification",
  "message": "External notification"
}

Response command example​

curl -k -sS -X PUT "https://{controller_ip}/api/v1/notification_events/user_defined_notifications/{uuid}" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "status": "success",
  "data": {
    "uuid": "<uuid>"
  }
}

DELETE /notification_events/user_defined/{uuid}​

Section: Notifications.

Deletes data for the notifications endpoint /notification_events/user_defined/{uuid}.

Request example​

curl -k -X DELETE "https://{controller_ip}/api/v1/notification_events/user_defined/{uuid}" \
  -H "Authorization: Bearer <token>"

Response command example​

curl -k -sS -X DELETE "https://{controller_ip}/api/v1/notification_events/user_defined/{uuid}" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "status": "success",
  "deleted": true
}

DELETE /notification_events/user_defined_notifications/{uuid}​

Section: Notifications.

Deletes data for the notifications endpoint /notification_events/user_defined_notifications/{uuid}.

Request example​

curl -k -X DELETE "https://{controller_ip}/api/v1/notification_events/user_defined_notifications/{uuid}" \
  -H "Authorization: Bearer <token>"

Response command example​

curl -k -sS -X DELETE "https://{controller_ip}/api/v1/notification_events/user_defined_notifications/{uuid}" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "status": "success",
  "deleted": true
}