Skip to main content

Access profiles API 1.5.0

Access profiles and access rules.

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/access_profiles/
GET/access_profiles/{uuid}
POST/access_profiles/
PUT/access_profiles/{uuid}
DELETE/access_profiles/{uuid}

GET /access_profiles/​

Section: Access profiles.

Returns data for the access profiles endpoint /access_profiles/.

Request example​

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

Response command example​

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

Response example​

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

GET /access_profiles/{uuid}​

Section: Access profiles.

Returns data for the access profiles endpoint /access_profiles/{uuid}.

Request example​

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

Response command example​

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

Response example​

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

POST /access_profiles/​

Section: Access profiles.

Creates a record or starts an operation for the access profiles endpoint /access_profiles/.

Request example​

curl -k -X POST "https://{controller_ip}/api/v1/access_profiles/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "name": "Office staff",
  "access_points": [
    "<access_point_uuid>"
  ],
  "schedule_uuid": "<schedule_uuid>"
}'

Request body example​

{
  "name": "Office staff",
  "access_points": [
    "<access_point_uuid>"
  ],
  "schedule_uuid": "<schedule_uuid>"
}

Response command example​

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

Response example​

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

PUT /access_profiles/{uuid}​

Section: Access profiles.

Updates data for the access profiles endpoint /access_profiles/{uuid}.

Request example​

curl -k -X PUT "https://{controller_ip}/api/v1/access_profiles/{uuid}" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "name": "Office staff",
  "access_points": [
    "<access_point_uuid>"
  ],
  "schedule_uuid": "<schedule_uuid>"
}'

Request body example​

{
  "name": "Office staff",
  "access_points": [
    "<access_point_uuid>"
  ],
  "schedule_uuid": "<schedule_uuid>"
}

Response command example​

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

Response example​

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

DELETE /access_profiles/{uuid}​

Section: Access profiles.

Deletes data for the access profiles endpoint /access_profiles/{uuid}.

Request example​

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

Response command example​

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

Response example​

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