Skip to main content

Device management API 1.6.0

Device management and service operations.

Base path: https://{controller_ip}/api/v1. API description version: 1.6.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
POST/device_management/send_event
POST/device_management/send_pass_event

POST /device_management/send_event​

Section: Device management.

Creates a record or starts an operation for the device management endpoint /device_management/send_event.

Request example​

curl -k -X POST "https://{controller_ip}/api/v1/device_management/send_event" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "device_uuid": "<device_uuid>",
  "event_type": "external_event"
}'

Request body example​

{
  "device_uuid": "<device_uuid>",
  "event_type": "external_event"
}

Response command example​

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

Response example​

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

POST /device_management/send_pass_event​

Section: Device management.

Creates a record or starts an operation for the device management endpoint /device_management/send_pass_event.

Request example​

curl -k -X POST "https://{controller_ip}/api/v1/device_management/send_pass_event" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "access_point_uuid": "<access_point_uuid>",
  "direction": "in",
  "user_uuid": "<user_uuid>"
}'

Request body example​

{
  "access_point_uuid": "<access_point_uuid>",
  "direction": "in",
  "user_uuid": "<user_uuid>"
}

Response command example​

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

Response example​

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