Skip to main content

Directories API 1.6.0

Reference directories and dictionary values.

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
GET/directories
GET/directories/{name}
POST/directories
PUT/directories/{name}
DELETE/directories/{name}

GET /directories​

Section: Directories.

Returns data for the directories endpoint /directories.

Request example​

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

Response command example​

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

Response example​

{
  "data": [],
  "meta": {
    "api_version": "1.6.0",
    "path": "/directories"
  }
}

GET /directories/{name}​

Section: Directories.

Returns data for the directories endpoint /directories/{name}.

Request example​

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

Response command example​

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

Response example​

{
  "data": [],
  "meta": {
    "api_version": "1.6.0",
    "path": "/directories/{name}"
  }
}

POST /directories​

Section: Directories.

Creates a record or starts an operation for the directories endpoint /directories.

Request example​

curl -k -X POST "https://{controller_ip}/api/v1/directories" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "name": "departments",
  "items": [
    {
      "value": "security",
      "label": "Security service"
    }
  ]
}'

Request body example​

{
  "name": "departments",
  "items": [
    {
      "value": "security",
      "label": "Security service"
    }
  ]
}

Response command example​

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

Response example​

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

PUT /directories/{name}​

Section: Directories.

Updates data for the directories endpoint /directories/{name}.

Request example​

curl -k -X PUT "https://{controller_ip}/api/v1/directories/{name}" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "name": "departments",
  "items": [
    {
      "value": "security",
      "label": "Security service"
    }
  ]
}'

Request body example​

{
  "name": "departments",
  "items": [
    {
      "value": "security",
      "label": "Security service"
    }
  ]
}

Response command example​

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

Response example​

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

DELETE /directories/{name}​

Section: Directories.

Deletes data for the directories endpoint /directories/{name}.

Request example​

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

Response command example​

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

Response example​

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