Skip to main content

Temporary access API 1.5.0

Temporary and one-time access operations.

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/tmp_access
GET/tmp_access/by_date/{date}
GET/tmp_access/by_user/{user_uuid}
GET/tmp_access/by_user_and_date/{user_uuid}/{date}
GET/tmp_access/{uuid}
POST/tmp_access
PUT/tmp_access/{uuid}
DELETE/tmp_access/{uuid}

GET /tmp_access

Section: Temporary access.

Returns data for the temporary access endpoint /tmp_access.

Request example

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

Response command example

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

Response example

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

GET /tmp_access/by_date/{date}

Section: Temporary access.

Returns data for the temporary access endpoint /tmp_access/by_date/{date}.

Request example

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

Response command example

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

Response example

{
"data": [],
"meta": {
"api_version": "1.5.0",
"path": "/tmp_access/by_date/{date}"
}
}

GET /tmp_access/by_user/{user_uuid}

Section: Temporary access.

Returns data for the temporary access endpoint /tmp_access/by_user/{user_uuid}.

Request example

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

Response command example

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

Response example

{
"data": [],
"meta": {
"api_version": "1.5.0",
"path": "/tmp_access/by_user/{user_uuid}"
}
}

GET /tmp_access/by_user_and_date/{user_uuid}/{date}

Section: Temporary access.

Returns data for the temporary access endpoint /tmp_access/by_user_and_date/{user_uuid}/{date}.

Request example

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

Response command example

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

Response example

[
{
"uuid": "<tmp_access_uuid>",
"user_uuid": "<user_uuid>",
"date": "25.02.2022",
"access_points": ["<access_point_uuid>"]
}
]

GET /tmp_access/{uuid}

Section: Temporary access.

Returns data for the temporary access endpoint /tmp_access/{uuid}.

Request example

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

Response command example

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

Response example

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

POST /tmp_access

Section: Temporary access.

Creates a record or starts an operation for the temporary access endpoint /tmp_access.

Request example

curl -k -X POST "https://{controller_ip}/api/v1/tmp_access" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
--data-raw '{
"user_uuid": "<user_uuid>",
"access_point_uuid": "<access_point_uuid>",
"date": "2026-06-16"
}'

Request body example

{
"user_uuid": "<user_uuid>",
"access_point_uuid": "<access_point_uuid>",
"date": "2026-06-16"
}

Response command example

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

Response example

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

PUT /tmp_access/{uuid}

Section: Temporary access.

Updates data for the temporary access endpoint /tmp_access/{uuid}.

Request example

curl -k -X PUT "https://{controller_ip}/api/v1/tmp_access/{uuid}" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
--data-raw '{
"user_uuid": "<user_uuid>",
"access_point_uuid": "<access_point_uuid>",
"date": "2026-06-16"
}'

Request body example

{
"user_uuid": "<user_uuid>",
"access_point_uuid": "<access_point_uuid>",
"date": "2026-06-16"
}

Response command example

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

Response example

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

DELETE /tmp_access/{uuid}

Section: Temporary access.

Deletes data for the temporary access endpoint /tmp_access/{uuid}.

Request example

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

Response command example

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

Response example

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