Access points API 1.6.0
Access points, modes, parameters and access point state.
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
GET /access_points
Section: Access points.
Returns data for the access points endpoint /access_points.
Request example
curl -k -X GET "https://{controller_ip}/api/v1/access_points" \
-H "Authorization: Bearer <token>"
Response command example
curl -k -sS -X GET "https://{controller_ip}/api/v1/access_points" \
-H "Authorization: Bearer <token>" | jq .
Response example
{
"data": [],
"meta": {
"api_version": "1.6.0",
"path": "/access_points"
}
}
GET /access_points/ext_parameters
Section: Access points.
Returns data for the access points endpoint /access_points/ext_parameters.
Request example
curl -k -X GET "https://{controller_ip}/api/v1/access_points/ext_parameters" \
-H "Authorization: Bearer <token>"
Response command example
curl -k -sS -X GET "https://{controller_ip}/api/v1/access_points/ext_parameters" \
-H "Authorization: Bearer <token>" | jq .
Response example
{
"data": [],
"meta": {
"api_version": "1.6.0",
"path": "/access_points/ext_parameters"
}
}
GET /access_points/ext_parameters/sections
Section: Access points.
Returns reference values for the access points endpoint /access_points/ext_parameters/sections.
Request example
curl -k -X GET "https://{controller_ip}/api/v1/access_points/ext_parameters/sections" \
-H "Authorization: Bearer <token>"
Response command example
curl -k -sS -X GET "https://{controller_ip}/api/v1/access_points/ext_parameters/sections" \
-H "Authorization: Bearer <token>" | jq .
Response example
{
"data": [],
"meta": {
"api_version": "1.6.0",
"path": "/access_points/ext_parameters/sections"
}
}
GET /access_points/{uuid}
Section: Access points.
Returns data for the access points endpoint /access_points/{uuid}.
Request example
curl -k -X GET "https://{controller_ip}/api/v1/access_points/{uuid}" \
-H "Authorization: Bearer <token>"
Response command example
curl -k -sS -X GET "https://{controller_ip}/api/v1/access_points/{uuid}" \
-H "Authorization: Bearer <token>" | jq .
Response example
{
"data": [],
"meta": {
"api_version": "1.6.0",
"path": "/access_points/{uuid}"
}
}
GET /access_points_automations
Section: Access points.
Returns data for the access points endpoint /access_points_automations.
Request example
curl -k -X GET "https://{controller_ip}/api/v1/access_points_automations" \
-H "Authorization: Bearer <token>"
Response command example
curl -k -sS -X GET "https://{controller_ip}/api/v1/access_points_automations" \
-H "Authorization: Bearer <token>" | jq .
Response example
{
"data": [],
"meta": {
"api_version": "1.6.0",
"path": "/access_points_automations"
}
}
GET /access_points_automations/{uuid}
Section: Access points.
Returns data for the access points endpoint /access_points_automations/{uuid}.
Request example
curl -k -X GET "https://{controller_ip}/api/v1/access_points_automations/{uuid}" \
-H "Authorization: Bearer <token>"
Response command example
curl -k -sS -X GET "https://{controller_ip}/api/v1/access_points_automations/{uuid}" \
-H "Authorization: Bearer <token>" | jq .
Response example
{
"data": [],
"meta": {
"api_version": "1.6.0",
"path": "/access_points_automations/{uuid}"
}
}
POST /access_points/barrier
Section: Access points.
Creates a record or starts an operation for the access points endpoint /access_points/barrier.
Request example
curl -k -X POST "https://{controller_ip}/api/v1/access_points/barrier" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
--data-raw '{
"name": "Main entrance",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}'
Request body example
{
"name": "Main entrance",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}
Response command example
curl -k -sS -X POST "https://{controller_ip}/api/v1/access_points/barrier" \
-H "Authorization: Bearer <token>" | jq .
Response example
{
"status": "success",
"data": {
"uuid": "<uuid>"
}
}
POST /access_points/double
Section: Access points.
Creates a record or starts an operation for the access points endpoint /access_points/double.
Request example
curl -k -X POST "https://{controller_ip}/api/v1/access_points/double" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
--data-raw '{
"name": "Main entrance",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}'
Request body example
{
"name": "Main entrance",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}
Response command example
curl -k -sS -X POST "https://{controller_ip}/api/v1/access_points/double" \
-H "Authorization: Bearer <token>" | jq .
Response example
{
"status": "success",
"data": {
"uuid": "<uuid>"
}
}
POST /access_points/mantrap
Section: Access points.
Creates a record or starts an operation for the access points endpoint /access_points/mantrap.
Request example
curl -k -X POST "https://{controller_ip}/api/v1/access_points/mantrap" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
--data-raw '{
"name": "Main entrance",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}'
Request body example
{
"name": "Main entrance",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}
Response command example
curl -k -sS -X POST "https://{controller_ip}/api/v1/access_points/mantrap" \
-H "Authorization: Bearer <token>" | jq .
Response example
{
"status": "success",
"data": {
"uuid": "<uuid>"
}
}
POST /access_points/single
Section: Access points.
Creates a record or starts an operation for the access points endpoint /access_points/single.
Request example
curl -k -X POST "https://{controller_ip}/api/v1/access_points/single" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
--data-raw '{
"name": "Main entrance",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}'
Request body example
{
"name": "Main entrance",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}
Response command example
curl -k -sS -X POST "https://{controller_ip}/api/v1/access_points/single" \
-H "Authorization: Bearer <token>" | jq .
Response example
{
"status": "success",
"data": {
"uuid": "<uuid>"
}
}
POST /access_points/turnstile
Section: Access points.
Creates a record or starts an operation for the access points endpoint /access_points/turnstile.
Request example
curl -k -X POST "https://{controller_ip}/api/v1/access_points/turnstile" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
--data-raw '{
"name": "Main entrance",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}'
Request body example
{
"name": "Main entrance",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}
Response command example
curl -k -sS -X POST "https://{controller_ip}/api/v1/access_points/turnstile" \
-H "Authorization: Bearer <token>" | jq .
Response example
{
"status": "success",
"data": {
"uuid": "<uuid>"
}
}
POST /access_points/turnstile_with_card_box
Section: Access points.
Creates a record or starts an operation for the access points endpoint /access_points/turnstile_with_card_box.
Request example
curl -k -X POST "https://{controller_ip}/api/v1/access_points/turnstile_with_card_box" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
--data-raw '{
"name": "Main entrance",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}'
Request body example
{
"name": "Main entrance",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}
Response command example
curl -k -sS -X POST "https://{controller_ip}/api/v1/access_points/turnstile_with_card_box" \
-H "Authorization: Bearer <token>" | jq .
Response example
{
"status": "success",
"data": {
"uuid": "<uuid>"
}
}
POST /access_points/{uuid}/state/{state}
Section: Access points.
Creates a record or starts an operation for the access points endpoint /access_points/{uuid}/state/{state}.
Request example
curl -k -X POST "https://{controller_ip}/api/v1/access_points/{uuid}/state/{state}" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
--data-raw '{
"name": "Main entrance",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}'
Request body example
{
"name": "Main entrance",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}
Response command example
curl -k -sS -X POST "https://{controller_ip}/api/v1/access_points/{uuid}/state/{state}" \
-H "Authorization: Bearer <token>" | jq .
Response example
{
"status": "success",
"data": {
"uuid": "<uuid>"
}
}
POST /access_points_automations
Section: Access points.
Creates a record or starts an operation for the access points endpoint /access_points_automations.
Request example
curl -k -X POST "https://{controller_ip}/api/v1/access_points_automations" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
--data-raw '{
"name": "Main entrance",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}'
Request body example
{
"name": "Main entrance",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}
Response command example
curl -k -sS -X POST "https://{controller_ip}/api/v1/access_points_automations" \
-H "Authorization: Bearer <token>" | jq .
Response example
{
"status": "success",
"data": {
"uuid": "<uuid>"
}
}
PUT /access_points/barrier/{uuid}
Section: Access points.
Updates data for the access points endpoint /access_points/barrier/{uuid}.
Request example
curl -k -X PUT "https://{controller_ip}/api/v1/access_points/barrier/{uuid}" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
--data-raw '{
"name": "Main entrance",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}'
Request body example
{
"name": "Main entrance",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}
Response command example
curl -k -sS -X PUT "https://{controller_ip}/api/v1/access_points/barrier/{uuid}" \
-H "Authorization: Bearer <token>" | jq .
Response example
{
"status": "success",
"data": {
"uuid": "<uuid>"
}
}
PUT /access_points/double/{uuid}
Section: Access points.
Updates data for the access points endpoint /access_points/double/{uuid}.
Request example
curl -k -X PUT "https://{controller_ip}/api/v1/access_points/double/{uuid}" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
--data-raw '{
"name": "Main entrance",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}'
Request body example
{
"name": "Main entrance",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}
Response command example
curl -k -sS -X PUT "https://{controller_ip}/api/v1/access_points/double/{uuid}" \
-H "Authorization: Bearer <token>" | jq .
Response example
{
"status": "success",
"data": {
"uuid": "<uuid>"
}
}
PUT /access_points/mantrap/{uuid}
Section: Access points.
Updates data for the access points endpoint /access_points/mantrap/{uuid}.
Request example
curl -k -X PUT "https://{controller_ip}/api/v1/access_points/mantrap/{uuid}" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
--data-raw '{
"name": "Main mantrap",
"type": "mantrap",
"controller_uuid": "<controller_uuid>"
}'
Request body example
{
"name": "Main mantrap",
"type": "mantrap",
"controller_uuid": "<controller_uuid>"
}
Response command example
curl -k -sS -X PUT "https://{controller_ip}/api/v1/access_points/mantrap/{uuid}" \
-H "Authorization: Bearer <token>" | jq .
Response example
{
"status": "success",
"data": {
"uuid": "<uuid>"
}
}
PUT /access_points/single/{uuid}
Section: Access points.
Updates data for the access points endpoint /access_points/single/{uuid}.
Request example
curl -k -X PUT "https://{controller_ip}/api/v1/access_points/single/{uuid}" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
--data-raw '{
"name": "Main entrance",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}'
Request body example
{
"name": "Main entrance",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}
Response command example
curl -k -sS -X PUT "https://{controller_ip}/api/v1/access_points/single/{uuid}" \
-H "Authorization: Bearer <token>" | jq .
Response example
{
"status": "success",
"data": {
"uuid": "<uuid>"
}
}
PUT /access_points/turnstile/{uuid}
Section: Access points.
Updates data for the access points endpoint /access_points/turnstile/{uuid}.
Request example
curl -k -X PUT "https://{controller_ip}/api/v1/access_points/turnstile/{uuid}" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
--data-raw '{
"name": "Main entrance",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}'
Request body example
{
"name": "Main entrance",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}
Response command example
curl -k -sS -X PUT "https://{controller_ip}/api/v1/access_points/turnstile/{uuid}" \
-H "Authorization: Bearer <token>" | jq .
Response example
{
"status": "success",
"data": {
"uuid": "<uuid>"
}
}
PUT /access_points/turnstile_with_card_box/{uuid}
Section: Access points.
Updates data for the access points endpoint /access_points/turnstile_with_card_box/{uuid}.
Request example
curl -k -X PUT "https://{controller_ip}/api/v1/access_points/turnstile_with_card_box/{uuid}" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
--data-raw '{
"name": "Main entrance",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}'
Request body example
{
"name": "Main entrance",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}
Response command example
curl -k -sS -X PUT "https://{controller_ip}/api/v1/access_points/turnstile_with_card_box/{uuid}" \
-H "Authorization: Bearer <token>" | jq .
Response example
{
"status": "success",
"data": {
"uuid": "<uuid>"
}
}
PUT /access_points_automations/{uuid}
Section: Access points.
Updates data for the access points endpoint /access_points_automations/{uuid}.
Request example
curl -k -X PUT "https://{controller_ip}/api/v1/access_points_automations/{uuid}" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
--data-raw '{
"name": "Main entrance",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}'
Request body example
{
"name": "Main entrance",
"type": "turnstile",
"controller_uuid": "<controller_uuid>"
}
Response command example
curl -k -sS -X PUT "https://{controller_ip}/api/v1/access_points_automations/{uuid}" \
-H "Authorization: Bearer <token>" | jq .
Response example
{
"status": "success",
"data": {
"uuid": "<uuid>"
}
}
DELETE /access_points/{uuid}
Section: Access points.
Deletes data for the access points endpoint /access_points/{uuid}.
Request example
curl -k -X DELETE "https://{controller_ip}/api/v1/access_points/{uuid}" \
-H "Authorization: Bearer <token>"
Response command example
curl -k -sS -X DELETE "https://{controller_ip}/api/v1/access_points/{uuid}" \
-H "Authorization: Bearer <token>" | jq .
Response example
{
"status": "success",
"deleted": true
}
DELETE /access_points_automations/{uuid}
Section: Access points.
Deletes data for the access points endpoint /access_points_automations/{uuid}.
Request example
curl -k -X DELETE "https://{controller_ip}/api/v1/access_points_automations/{uuid}" \
-H "Authorization: Bearer <token>"
Response command example
curl -k -sS -X DELETE "https://{controller_ip}/api/v1/access_points_automations/{uuid}" \
-H "Authorization: Bearer <token>" | jq .
Response example
{
"status": "success",
"deleted": true
}