ExtremeCloud IQ™ API allows customers and partners to create solutions for the management, monitoring, and provisioning of any ExtremeCloud IQ™ environment.

The API documentation is still under draft.

API Guide

Concepts

We will explain some basic concepts in our ExtremeCloud IQ™ platform.

Term Description

XIQ

ExtremeCloud IQ™. The account created by the customer in our platform.

VIQ

Virtual ExtremeCloud IQ™. The VIQ data are stored at Regional Data Center (RDC). Ideally one XIQ account can have multiple VIQs, but currently we only allow one VIQ per XIQ.

HIQ

Hierarchical ExtremeCloud IQ™, a special XIQ account type allows the customers offers managed service using our platform to their own customers. In this mode, each VIQ can be further partitioned to multiple organizations (ORG).

ORG

HIQ organization, a logical unit in VIQ. An ORG in HIQ is similar to a VIQ in normal XIQ account.

GDC

Global Data Center. Store those data for customer’s accounts information and users information. We have multiple GDCs to store customer information in different countries to obey their laws and regulations.

RDC

Regional Data Center. Store those data for customer networks, such as devices, configurations, metrics, etc.

REST API Overview

All of our REST APIs strives to follow RESTful API best practices.

Endpoint

There are dozens of data centers managed by ExtremeCloud IQ™. Customer data and VIQ data are stored in one of them.

ExtremeCloud IQ™ provides a uniform API endpoint for users so that they don’t need to know which specific RDC to access.

The endpoint URL prefix: https://api.extremecloudiq.com
All API access is over HTTPS.

Path Templating

Path templating refers to the usage of curly braces {} to mark a section of a URL path as replaceable using path parameters.

HTTP Verbs

Where possible, REST API strives to use appropriate HTTP verbs for each action.

HTTP Verb Description

GET

Retrieving resources.

POST

Creating resources or calling business operations.

PUT

Replacing resources or creating resources if the resources don’t exist.

PATCH

Updating resources with partial JSON data. PATCH is a relatively new and uncommon HTTP verb, so resource endpoints also accept PUT requests.

DELETE

Deleting resources.

Media Type

All data is sent and received as JSON format if no explicit requirement.
HTTP Headers
Content-Type: application/json
Accept: application/json

HTTP Status Code

The HTTP Status Codes are used to indicate the status of the executed operation.

Table 1. Success
HTTP Status Code Description Use Cases

200

OK

Standard response for successful HTTP requests.

201

Created

The request has been fulfilled, resulting in the creation of a new resource.

202

Accepted

The request is queued for background processing (async tasks).

204

No Content

The server successfully processed the request and is not returning any content.

Table 2. Client Error
HTTP Status Description Use Cases Client recovery policy

400

Bad Request

The API endpoint exists, but the HTTP request syntax or payload is incorrect, detail will be given in response.

Do not retry. Fix the request.

401

Unauthorized

The server can be reached and understood the request, but refuses to take any further action, because the client must provide authorization.

If the client has provided authorization, the server is indicating the provided authorization is unsuitable or invalid.

If the user has not supplied authorization information, prompt them for the appropriate credentials.

If the user has supplied authorization information, inform them their credentials were rejected and optionally prompt them again.

403

Forbidden

The server can be reached and understood the request, but refuses to take any further action, because it is configured to deny access for some reason to the requested resource by the client.

Do not retry. Fix the request.

404

Not Found

The API endpoint doesn’t exist or resource doesn’t exist.

Do not retry. Fix the request.

415

Unsupported Media Type

The request entity has a media type which the server or resource does not support.

Do not retry. Fix the request.

Table 3. Server Error
HTTP Status Code Description Use Cases Client recovery policy

500

Internal Server Error

Server side Exception caught, detail will be given in response.

Ask user to retry later or the client automatically calls retry request.

503

Service Unavailable

The server is temporary unavailable.

Ask user to retry later or the client automatically calls retry request.

HTTP Response Schema

Successful Response

Successful response is the HTTP response with status code 2xx.

Single resource

Single resource response is object of key-value pairs.

{
  "key1": "...",
  "key2": 10,
  "key3": true
}
Multiple resources

Multiple resource response is the array of objects without pagination information.

[
  {
    "key1": "...",
    "key2": 10,
    "key3": true
  },
  {
    "key1": "...",
    "key2": 11,
    "key3": false
  }
]
Paged resources

Paged resource response is object with pagination information and array of paged objects.

{
  "pagination": {
    "total": {total objects},
    ""
  }
data: [
{
  "name1": "...",
  "name2": {number},
  "name3": true|false,
...
},
{
...
},
...
  ]
...
}
Unsuccessful Response

Unsuccessful response is the HTTP response with status code 4xx and 5xx.

Unsuccessful response schema
{
  "error": "...",
  "uuid": "...",
  "message": "..."
}
Name Required Description

error

The error code, used to classify different error type.

uuid

The unique identifier of the error message, used to locate error message in the backend.

message

The associated descriptive error message.

Common Fields
Name Format

Timestamp

ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ

REST API Reference

Authentication

Login

POST /login
Request Body
{
  "password" : "aerohive",
  "username" : "admin@cust001.com"
}
Table 4. Parameters
Path Type Description

username

String

The login username

password

String

The login password

Successful Login Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
Content-Length: 1122
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "access_token" : "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTk2LCJleHAiOjE2MzM0NjI5OTZ9.ybsotoTEhqfNMuCfwFkjMsgtnb9z2PBrcKyavVJrJ48"
}
Unsuccessful Login Response
HTTP/1.1 400 Bad Request
Pragma: no-cache
Content-Length: 130
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "error_code" : "ServerError",
  "error_id" : "80f41ff0b9cb41e1acf84c8a3d5c908d",
  "error_message" : "Authentication failed"
}

Authorization

Generate API Token

POST /auth/apitoken
Request Fields
Path Type Description

expire_time

Number

The token expire time, format is the number of seconds from epoch of 1970-01-01T00:00:00Z. If null means no expiration, the minimum value is current time plus 300 seconds.

permissions

Array

The permission list.

description

String

The token description

HTTP Request
POST /auth/apitoken HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTk0LCJleHAiOjE2MzM0NjI5OTR9.DQo37mNmTp_zzfZj_nY_EcvgvYzGztjeenQnZXsivxk
Content-Type: application/json
Content-Length: 118
Host: localhost:8080

{
  "description" : "API Token for account read.",
  "expire_time" : 1632861794,
  "permissions" : [ "write*:auth" ]
}
Response Fields
Path Type Description

access_token

String

The API access token.

create_time

String

The create timestamp.

expire_time

String

The expire timestamp.

creator_id

Number

The user ID who created the API token.

customer_id

Number

The customer ID who owns the API token.

description

String

The description for the API token.

permissions

Array

The permissions for the API token.

HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Content-Length: 565

{
  "access_token" : "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInNjb3BlcyI6WyJyZWFkOmFjY291bnQiXSwidXNlcklkIjoxLCJyb2xlIjoiQWRtaW5pc3RyYXRvciIsIm93bmVySWQiOjEwMiwiZGF0YUNlbnRlciI6IlVTX1dlc3QiLCJpc3MiOiJleHRyZW1lY2xvdWRpcS5jb20iLCJpYXQiOjE1OTgzNTg3NDYsImV4cCI6MTU5ODM2MjM0Nn0.aP5lD3i8TfmGSWeGacXmJfhne9rSI_06iaGOzdzMj4k",
  "create_time" : "2021-09-28T19:43:14.000+0000",
  "expire_time" : "2021-09-28T20:43:14.000+0000",
  "creator_id" : 1,
  "customer_id" : 1,
  "description" : "API Token for account read.",
  "permissions" : [ "read:account" ]
}
cURL Request
$ curl 'http://localhost:8080/auth/apitoken' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTk0LCJleHAiOjE2MzM0NjI5OTR9.DQo37mNmTp_zzfZj_nY_EcvgvYzGztjeenQnZXsivxk' \
    -H 'Content-Type: application/json' \
    -d '{
  "description" : "API Token for account read.",
  "expire_time" : 1632861794,
  "permissions" : [ "write*:auth" ]
}'

Get API Token details

GET /auth/apitoken/info
HTTP Request
GET /auth/apitoken/info HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTk0LCJleHAiOjE2MzM0NjI5OTR9.DQo37mNmTp_zzfZj_nY_EcvgvYzGztjeenQnZXsivxk
Content-Type: application/json
Host: localhost:8080
Response Fields
Path Type Description

user_id

Number

Account ID.

user_name

String

Account login name.

role

String

User role.

owner_id

Number

User’s home ownerId.

data_center

String

User’s data center.

scopes

Array

Login user’s permissions.

issued_at

String

The time at which the JWT was issued.

expiration_time

String

The expiration time on or after which the JWT MUST NOT be accepted for processing.

expires_in

Number

How many seconds when this token will expires.

HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Content-Length: 866
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "role" : "Administrator",
  "user_name" : "admin@cust001.com",
  "user_id" : 1,
  "owner_id" : 102,
  "data_center" : "US_WEST",
  "scopes" : [ "auth", "auth:r", "token:new", "perm:check", "account", "account:r", "user", "user:r", "hiq", "hiq:r", "hiq:enable", "org", "org:new", "org:del", "org:rename", "hiq.ctx", "hiq.ctx:r", "hiq.ctx:w", "device", "device:r", "device:list", "device:view", "device:new", "device:del", "device:cli", "device:deploy", "device:manage", "device:unmanage", "device:reboot", "client", "client:r", "locations", "locations:r", "network-policy", "network-policy:r", "ssid", "ssid:r", "pcg-key-based", "pcg-key-based:r", "subscriptions-webhook", "subscriptions-webhook:r", "ccg", "ccg:r", "logs", "logs:r" ],
  "issued_at" : "2021-09-28T19:43:14.000+0000",
  "expiration_time" : "2021-10-05T19:43:14.000+0000",
  "expires_in" : 604799
}
cURL Request
$ curl 'http://localhost:8080/auth/apitoken/info' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTk0LCJleHAiOjE2MzM0NjI5OTR9.DQo37mNmTp_zzfZj_nY_EcvgvYzGztjeenQnZXsivxk' \
    -H 'Content-Type: application/json'

Get user permissions

GET /auth/permissions
HTTP Request
GET /auth/permissions HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTk0LCJleHAiOjE2MzM0NjI5OTR9.DQo37mNmTp_zzfZj_nY_EcvgvYzGztjeenQnZXsivxk
Content-Type: application/json
Host: localhost:8080
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Content-Length: 4582

[ {
  "name" : "auth",
  "description" : "Full control of authorization",
  "category" : "Authorization"
}, {
  "name" : "auth:r",
  "description" : "Read access to authorization",
  "category" : "Authorization"
}, {
  "name" : "token:new",
  "description" : "Generate API token",
  "category" : "Authorization"
}, {
  "name" : "perm:check",
  "description" : "Check permissions",
  "category" : "Authorization"
}, {
  "name" : "account",
  "description" : "Full control of account settings",
  "category" : "Account"
}, {
  "name" : "account:r",
  "description" : "Read access to account settings",
  "category" : "Account"
}, {
  "name" : "user",
  "description" : "Full control of users",
  "category" : "User"
}, {
  "name" : "user:r",
  "description" : "Read access to users",
  "category" : "User"
}, {
  "name" : "hiq",
  "description" : "Full control of HIQ",
  "category" : "HIQ"
}, {
  "name" : "hiq:r",
  "description" : "Read access to HIQ",
  "category" : "HIQ"
}, {
  "name" : "hiq:enable",
  "description" : "Enable HIQ (non-HIQ account only)",
  "category" : "HIQ"
}, {
  "name" : "org",
  "description" : "Full control of HIQ organizations (HIQ account only)",
  "category" : "HIQ"
}, {
  "name" : "org:new",
  "description" : "Create HIQ organization (HIQ account only)",
  "category" : "HIQ"
}, {
  "name" : "org:del",
  "description" : "Delete HIQ organization (HIQ account only)",
  "category" : "HIQ"
}, {
  "name" : "org:rename",
  "description" : "Rename HIQ organization (HIQ account only)",
  "category" : "HIQ"
}, {
  "name" : "hiq.ctx",
  "description" : "Full control of HIQ Context (HIQ account only)",
  "category" : "HIQ"
}, {
  "name" : "hiq.ctx:r",
  "description" : "Read access to HIQ Context (HIQ account only)",
  "category" : "HIQ"
}, {
  "name" : "hiq.ctx:w",
  "description" : "Switching HIQ Context (HIQ account only)",
  "category" : "HIQ"
}, {
  "name" : "device",
  "description" : "Full control of devices",
  "category" : "Device"
}, {
  "name" : "device:r",
  "description" : "Read access to devices",
  "category" : "Device"
}, {
  "name" : "device:list",
  "description" : "Get device list",
  "category" : "Device"
}, {
  "name" : "device:view",
  "description" : "View device details",
  "category" : "Device"
}, {
  "name" : "device:new",
  "description" : "Device onboarding",
  "category" : "Device"
}, {
  "name" : "device:del",
  "description" : "Delete device",
  "category" : "Device"
}, {
  "name" : "device:cli",
  "description" : "Send CLI to device",
  "category" : "Device"
}, {
  "name" : "device:deploy",
  "description" : "Device push config",
  "category" : "Device"
}, {
  "name" : "device:manage",
  "description" : "Change management status to MANAGED",
  "category" : "Device"
}, {
  "name" : "device:unmanage",
  "description" : "Change management status to UNMANAGED",
  "category" : "Device"
}, {
  "name" : "device:reboot",
  "description" : "Reboot device",
  "category" : "Device"
}, {
  "name" : "client",
  "description" : "Full control of clients",
  "category" : "Client"
}, {
  "name" : "client:r",
  "description" : "Read access to clients",
  "category" : "Client"
}, {
  "name" : "locations",
  "description" : "Full control of locations",
  "category" : "Locations"
}, {
  "name" : "locations:r",
  "description" : "Read access to locations",
  "category" : "Locations"
}, {
  "name" : "network-policy",
  "description" : "Full control of network-policy",
  "category" : "Network-Policy"
}, {
  "name" : "network-policy:r",
  "description" : "Read access to network-policy",
  "category" : "Network-Policy"
}, {
  "name" : "ssid",
  "description" : "Full control of SSID",
  "category" : "SSID"
}, {
  "name" : "ssid:r",
  "description" : "Read access to SSID",
  "category" : "SSID"
}, {
  "name" : "pcg-key-based",
  "description" : "Full control of PCG key based",
  "category" : "PCG"
}, {
  "name" : "pcg-key-based:r",
  "description" : "Read access to PCG key based",
  "category" : "PCG"
}, {
  "name" : "subscriptions-webhook",
  "description" : "Full control of webhook subscription",
  "category" : "WEBHOOK"
}, {
  "name" : "subscriptions-webhook:r",
  "description" : "Read access to webhook subscription",
  "category" : "WEBHOOK"
}, {
  "name" : "ccg",
  "description" : "Full control of CCG",
  "category" : "CCG"
}, {
  "name" : "ccg:r",
  "description" : "Read access to CCG",
  "category" : "CCG"
}, {
  "name" : "logs",
  "description" : "Full control of logs",
  "category" : "LOGS"
}, {
  "name" : "logs:r",
  "description" : "Read access to logs",
  "category" : "LOGS"
} ]
cURL Request
$ curl 'http://localhost:8080/auth/permissions' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTk0LCJleHAiOjE2MzM0NjI5OTR9.DQo37mNmTp_zzfZj_nY_EcvgvYzGztjeenQnZXsivxk' \
    -H 'Content-Type: application/json'

Check permissions

POST /auth/permissions/:check
Request Body
{
  "uri" : "http://localhost:8081/account/info",
  "method" : "get"
}
Table 5. Parameters
Path Type Description

uri

String

The request URI.

method

String

The HTTP request method.

HTTP Request
POST /auth/permissions/:check HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTk0LCJleHAiOjE2MzM0NjI5OTR9.DQo37mNmTp_zzfZj_nY_EcvgvYzGztjeenQnZXsivxk
Content-Length: 70
Content-Type: application/json
Host: localhost:8080

{
  "uri" : "http://localhost:8081/account/info",
  "method" : "get"
}
Response Fields
Path Type Description

roles[]

Array

The valid roles for request URI and request method

permissions[].name

String

The permission name.

permissions[].description

String

The permission description.

permissions[].category

String

The category for the permission.

HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Content-Length: 367

{
  "permissions" : [ {
    "name" : "account",
    "description" : "Full control of account settings",
    "category" : "Account"
  }, {
    "name" : "account:r",
    "description" : "Read access to account settings",
    "category" : "Account"
  } ],
  "roles" : [ "Operator", "Help Desk", "Administrator", "Monitor", "Installer", "Observer", "Guest Management" ]
}
cURL Request
$ curl 'http://localhost:8080/auth/permissions/:check' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTk0LCJleHAiOjE2MzM0NjI5OTR9.DQo37mNmTp_zzfZj_nY_EcvgvYzGztjeenQnZXsivxk' \
    -H 'Content-Type: application/json' \
    -d '{
  "uri" : "http://localhost:8081/account/info",
  "method" : "get"
}'

Account

Get basic info

GET /account/info
Request Fields
HTTP Request
GET /account/info HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkyLCJleHAiOjE2MzM0NjI5OTJ9.83eWqkoet6T3XzVre2rEk-FT5dvA7jhTD2qFwQFcAiE
Host: localhost:8080
Response Fields
Path Type Description

id

Number

Account ID.

name

String

Account name.

create_time

String

Account create time.

update_time

String

The last update time.

account_type

String

Account type.

account_mode

String

Account mode.

data_center

String

The default Regional Data Center (RDC) to hold data from customer network.

industry

String

The industry of the account belongs to.

country

String

The country for the account.

state

String

The state for the account, if any.

city

String

The city for the account.

address

String

The address for the account.

zipcode

String

The zipcode of the address.

HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Content-Length: 404
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "id" : 1,
  "name" : "admin@cust001.com",
  "industry" : "test industry",
  "country" : "US",
  "state" : "",
  "city" : "aaa",
  "address" : "test address",
  "zipcode" : "test zipcode",
  "create_time" : "2021-09-28T19:43:12.000+0000",
  "update_time" : "1970-01-01T00:00:00.000+0000",
  "account_type" : "ACCOUNT_TYPE_CUSTOMER",
  "account_mode" : "ACCOUNT_MODE_CONNECT",
  "data_center" : "VA2"
}
cURL Request
$ curl 'http://localhost:8080/account/info' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkyLCJleHAiOjE2MzM0NjI5OTJ9.83eWqkoet6T3XzVre2rEk-FT5dvA7jhTD2qFwQFcAiE'

Get VIQ info

GET /account/viq
Request Fields
HTTP Request
GET /account/viq HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkyLCJleHAiOjE2MzM0NjI5OTJ9.83eWqkoet6T3XzVre2rEk-FT5dvA7jhTD2qFwQFcAiE
Host: localhost:8080
Response Fields
Path Type Description

customer_id

String

Customer ID. a.k.a Salesforce customer ID.

vhm_id

String

Account name.

owner_id

Number

Owner Id. a.k.a VHM account ID.

devices

Number

Total # of licensed devices.

standalone

Boolean

Whether HHM/HIQ is enabled or if standalone VIQ.

expired

Boolean

The license subscription expired.

licenses[]

Array

The license info list.

licenses[].id

Number

The license id.

licenses[].status

String

The license status.

licenses[].mode

String

The license mode.

licenses[].create_time

String

The license create time.

licenses[].update_time

String

The license update time.

licenses[].active_date

String

The license active time.

licenses[].expire_date

String

The license expire time.

licenses[].entitlement_key

String

The license entitlement key.

licenses[].entitlement_type

String

The license entitlement type.

HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Length: 1027
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "devices" : 10,
  "standalone" : true,
  "expired" : false,
  "licenses" : [ {
    "id" : 1,
    "status" : "LICENSE_STATUS_EVAL",
    "mode" : "LICENSE_MODE_EVAL",
    "create_time" : "2021-09-28T19:43:12.000+0000",
    "update_time" : "2021-09-28T19:43:12.000+0000",
    "active_date" : "2021-09-28T19:43:12.000+0000",
    "expire_date" : "2022-09-28T19:43:12.000+0000",
    "entitlement_key" : "zzzzz-wwwww-wwwww-wwwww-wwwww-zzzzz",
    "entitlement_type" : "ENTITLEMENT_TYPE_EVALUATION"
  }, {
    "id" : 112,
    "status" : "LICENSE_STATUS_EVAL",
    "mode" : "LICENSE_MODE_EVAL",
    "create_time" : "2021-07-28T19:43:12.000+0000",
    "update_time" : "2021-07-28T19:43:12.000+0000",
    "active_date" : "2021-08-28T19:43:12.000+0000",
    "expire_date" : "2021-09-21T19:43:12.000+0000",
    "entitlement_key" : "wwwww-wwwww-wwwww-wwwww-wwwww-wwwww",
    "entitlement_type" : "ENTITLEMENT_TYPE_EVALUATION"
  } ],
  "customer_id" : "zzzzz-zzzzz-zzzzz-zzzzz-zzzzz-zzzzz",
  "vhm_id" : "VHM-000001",
  "owner_id" : 102
}
cURL Request
$ curl 'http://localhost:8080/account/viq' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkyLCJleHAiOjE2MzM0NjI5OTJ9.83eWqkoet6T3XzVre2rEk-FT5dvA7jhTD2qFwQFcAiE'

User

Get profile

GET /user/profile
HTTP Request
GET /user/profile HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTk2LCJleHAiOjE2MzM0NjI5OTZ9.ybsotoTEhqfNMuCfwFkjMsgtnb9z2PBrcKyavVJrJ48
Content-Type: application/json
Host: localhost:8080
Response Fields
Path Type Description

id

Number

User ID.

create_time

String

User create time.

update_time

String

User update time.

login_name

String

Login name, i.e. username or login Email.

first_name

String

The first name.

last_name

String

The last name, i.e. family name.

display_name

String

The name to display.

phone

String

The Phone Number.

job_title

String

The job title.

locale

String

The locale.

category

Null

The user category.

idle_timeout

Number

The idle timeout in minutes, the minimum value is 5 minutes and the maximum value is 4 hours.

last_login_time

String

The last login time.

org_id

Number

The HIQ org_id if it is HIQ user.

user_group_id

Number

The user group ID.

user_group_name

String

The user group name.

HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Content-Length: 465

{
  "id" : 1,
  "phone" : "0",
  "locale" : "US",
  "category" : null,
  "create_time" : "2021-09-28T19:43:16.000+0000",
  "update_time" : "2021-09-28T19:43:16.000+0000",
  "login_name" : "admin@cust001.com",
  "first_name" : "admin",
  "last_name" : "admin",
  "display_name" : "Administrator",
  "job_title" : "IT",
  "idle_timeout" : 10,
  "last_login_time" : "2021-09-28T19:43:16.000+0000",
  "org_id" : 0,
  "user_group_id" : 1,
  "user_group_name" : "admin"
}
cURL Request
$ curl 'http://localhost:8080/user/profile' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTk2LCJleHAiOjE2MzM0NjI5OTZ9.ybsotoTEhqfNMuCfwFkjMsgtnb9z2PBrcKyavVJrJ48' \
    -H 'Content-Type: application/json'

HIQ

Hierarchical ExtremeCloud IQ API are ONLY available for customers who enable HIQ feature.

HIQ feature allows large customers partition their VIQ to several small VIQs, each partition is called Organization.

Get HIQ status

GET /hiq/:status
HTTP Request
GET /hiq/status HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkzLCJleHAiOjE2MzM0NjI5OTN9.e1u2cmy993p8kDvaD2hFSNCx-Vs0gF07yE63yRWKC1w
Host: localhost:8080
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Content-Length: 22
Expires: 0
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "enabled" : true
}
cURL Request
$ curl 'http://localhost:8080/hiq/status' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkzLCJleHAiOjE2MzM0NjI5OTN9.e1u2cmy993p8kDvaD2hFSNCx-Vs0gF07yE63yRWKC1w'

Get HIQ context

Get the current effective HIQ context for reading/creating data in organizations.

GET /hiq/context
HTTP Request
GET /hiq/context HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkzLCJleHAiOjE2MzM0NjI5OTN9.e1u2cmy993p8kDvaD2hFSNCx-Vs0gF07yE63yRWKC1w
Host: localhost:8080
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Length: 62
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "reading_org_ids" : [ 1, 2, 3 ],
  "creating_org_id" : 1
}
cURL Request
$ curl 'http://localhost:8080/hiq/context' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkzLCJleHAiOjE2MzM0NjI5OTN9.e1u2cmy993p8kDvaD2hFSNCx-Vs0gF07yE63yRWKC1w'

Set HIQ context

Set the current effective HIQ context for reading/creating data in organizations.

PUT /hiq/context
HTTP Request
PUT /hiq/context HTTP/1.1
Content-Length: 62
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkzLCJleHAiOjE2MzM0NjI5OTN9.e1u2cmy993p8kDvaD2hFSNCx-Vs0gF07yE63yRWKC1w
Host: localhost:8080

{
  "reading_org_ids" : [ 1, 2, 3 ],
  "creating_org_id" : 1
}
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
cURL Request
$ curl 'http://localhost:8080/hiq/context' -i -X PUT \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkzLCJleHAiOjE2MzM0NjI5OTN9.e1u2cmy993p8kDvaD2hFSNCx-Vs0gF07yE63yRWKC1w' \
    -d '{
  "reading_org_ids" : [ 1, 2, 3 ],
  "creating_org_id" : 1
}'

Get creating context

Get organization for creating new data

GET /hiq/context/creating
HTTP Request
GET /hiq/context/creating HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkzLCJleHAiOjE2MzM0NjI5OTN9.e1u2cmy993p8kDvaD2hFSNCx-Vs0gF07yE63yRWKC1w
Host: localhost:8080
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Content-Length: 1

1
cURL Request
$ curl 'http://localhost:8080/hiq/context/creating' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkzLCJleHAiOjE2MzM0NjI5OTN9.e1u2cmy993p8kDvaD2hFSNCx-Vs0gF07yE63yRWKC1w'

Set creating context

Set organization for creating new data

PUT /hiq/context/creating
HTTP Request
PUT /hiq/context/creating HTTP/1.1
Content-Type: application/json
Content-Length: 1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkzLCJleHAiOjE2MzM0NjI5OTN9.e1u2cmy993p8kDvaD2hFSNCx-Vs0gF07yE63yRWKC1w
Host: localhost:8080

1
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
cURL Request
$ curl 'http://localhost:8080/hiq/context/creating' -i -X PUT \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkzLCJleHAiOjE2MzM0NjI5OTN9.e1u2cmy993p8kDvaD2hFSNCx-Vs0gF07yE63yRWKC1w' \
    -d '1'

Get reading context

Get organizations for reading data

GET /hiq/context/reading
HTTP Request
GET /hiq/context/reading HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkzLCJleHAiOjE2MzM0NjI5OTN9.e1u2cmy993p8kDvaD2hFSNCx-Vs0gF07yE63yRWKC1w
Host: localhost:8080
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Content-Length: 11
Expires: 0
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

[ 1, 2, 3 ]
cURL Request
$ curl 'http://localhost:8080/hiq/context/reading' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkzLCJleHAiOjE2MzM0NjI5OTN9.e1u2cmy993p8kDvaD2hFSNCx-Vs0gF07yE63yRWKC1w'

Set reading context

Set organizations for reading data

PUT /hhm/context/reading
HTTP Request
PUT /hiq/context/reading HTTP/1.1
Content-Length: 11
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkzLCJleHAiOjE2MzM0NjI5OTN9.e1u2cmy993p8kDvaD2hFSNCx-Vs0gF07yE63yRWKC1w
Host: localhost:8080

[ 1, 2, 3 ]
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
cURL Request
$ curl 'http://localhost:8080/hiq/context/reading' -i -X PUT \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkzLCJleHAiOjE2MzM0NjI5OTN9.e1u2cmy993p8kDvaD2hFSNCx-Vs0gF07yE63yRWKC1w' \
    -d '[ 1, 2, 3 ]'

Create organization

POST /organizations
HTTP Request
POST /hiq/organizations HTTP/1.1
Content-Type: application/json
Content-Length: 56
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkzLCJleHAiOjE2MzM0NjI5OTN9.e1u2cmy993p8kDvaD2hFSNCx-Vs0gF07yE63yRWKC1w
Host: localhost:8080

{
  "name" : "example-organization",
  "color" : "red"
}
HTTP Response
HTTP/1.1 201 Created
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Length: 205
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "id" : 0,
  "name" : "",
  "type" : "ORGANIZATION_TYPE_UNSPECIFIED",
  "color" : "",
  "create_time" : "1970-01-01T00:00:00.000+0000",
  "update_time" : "1970-01-01T00:00:00.000+0000",
  "org_id" : 0
}
cURL Request
$ curl 'http://localhost:8080/hiq/organizations' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkzLCJleHAiOjE2MzM0NjI5OTN9.e1u2cmy993p8kDvaD2hFSNCx-Vs0gF07yE63yRWKC1w' \
    -d '{
  "name" : "example-organization",
  "color" : "red"
}'

Delete organization

DELETE /organizations/{id}
HTTP Request
DELETE /hiq/organizations/1 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkzLCJleHAiOjE2MzM0NjI5OTN9.e1u2cmy993p8kDvaD2hFSNCx-Vs0gF07yE63yRWKC1w
Host: localhost:8080
HTTP Response
HTTP/1.1 204 No Content
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
cURL Request
$ curl 'http://localhost:8080/hiq/organizations/1' -i -X DELETE \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkzLCJleHAiOjE2MzM0NjI5OTN9.e1u2cmy993p8kDvaD2hFSNCx-Vs0gF07yE63yRWKC1w'

Get all organizations

GET /organizations
HTTP Request
GET /hiq/organizations HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTk0LCJleHAiOjE2MzM0NjI5OTR9.DQo37mNmTp_zzfZj_nY_EcvgvYzGztjeenQnZXsivxk
Content-Type: application/json
Host: localhost:8080
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Length: 2204
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

[ {
  "id" : 1,
  "name" : "Example-corp-0",
  "type" : "ORGANIZATION_TYPE_REGULAR",
  "color" : "red",
  "create_time" : "2021-09-28T19:43:14.000+0000",
  "update_time" : "2021-09-28T19:43:14.000+0000",
  "org_id" : 1
}, {
  "id" : 2,
  "name" : "Example-corp-1",
  "type" : "ORGANIZATION_TYPE_REGULAR",
  "color" : "red",
  "create_time" : "2021-09-28T19:43:14.000+0000",
  "update_time" : "2021-09-28T19:43:14.000+0000",
  "org_id" : 2
}, {
  "id" : 3,
  "name" : "Example-corp-2",
  "type" : "ORGANIZATION_TYPE_REGULAR",
  "color" : "red",
  "create_time" : "2021-09-28T19:43:14.000+0000",
  "update_time" : "2021-09-28T19:43:14.000+0000",
  "org_id" : 3
}, {
  "id" : 4,
  "name" : "Example-corp-3",
  "type" : "ORGANIZATION_TYPE_REGULAR",
  "color" : "red",
  "create_time" : "2021-09-28T19:43:14.000+0000",
  "update_time" : "2021-09-28T19:43:14.000+0000",
  "org_id" : 4
}, {
  "id" : 5,
  "name" : "Example-corp-4",
  "type" : "ORGANIZATION_TYPE_REGULAR",
  "color" : "red",
  "create_time" : "2021-09-28T19:43:14.000+0000",
  "update_time" : "2021-09-28T19:43:14.000+0000",
  "org_id" : 5
}, {
  "id" : 6,
  "name" : "Example-corp-5",
  "type" : "ORGANIZATION_TYPE_REGULAR",
  "color" : "red",
  "create_time" : "2021-09-28T19:43:14.000+0000",
  "update_time" : "2021-09-28T19:43:14.000+0000",
  "org_id" : 6
}, {
  "id" : 7,
  "name" : "Example-corp-6",
  "type" : "ORGANIZATION_TYPE_REGULAR",
  "color" : "red",
  "create_time" : "2021-09-28T19:43:14.000+0000",
  "update_time" : "2021-09-28T19:43:14.000+0000",
  "org_id" : 7
}, {
  "id" : 8,
  "name" : "Example-corp-7",
  "type" : "ORGANIZATION_TYPE_REGULAR",
  "color" : "red",
  "create_time" : "2021-09-28T19:43:14.000+0000",
  "update_time" : "2021-09-28T19:43:14.000+0000",
  "org_id" : 8
}, {
  "id" : 9,
  "name" : "Example-corp-8",
  "type" : "ORGANIZATION_TYPE_REGULAR",
  "color" : "red",
  "create_time" : "2021-09-28T19:43:14.000+0000",
  "update_time" : "2021-09-28T19:43:14.000+0000",
  "org_id" : 9
}, {
  "id" : 10,
  "name" : "Example-corp-9",
  "type" : "ORGANIZATION_TYPE_REGULAR",
  "color" : "red",
  "create_time" : "2021-09-28T19:43:14.000+0000",
  "update_time" : "2021-09-28T19:43:14.000+0000",
  "org_id" : 10
} ]
cURL Request
$ curl 'http://localhost:8080/hiq/organizations' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTk0LCJleHAiOjE2MzM0NjI5OTR9.DQo37mNmTp_zzfZj_nY_EcvgvYzGztjeenQnZXsivxk' \
    -H 'Content-Type: application/json'

Rename organization

POST /organizations/{id}/:rename
HTTP Request
POST /hiq/organizations/1/:rename HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTk0LCJleHAiOjE2MzM0NjI5OTR9.DQo37mNmTp_zzfZj_nY_EcvgvYzGztjeenQnZXsivxk
Content-Length: 21
Content-Type: application/json
Host: localhost:8080

New organization name
HTTP Response
HTTP/1.1 204 No Content
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
cURL Request
$ curl 'http://localhost:8080/hiq/organizations/1/:rename' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTk0LCJleHAiOjE2MzM0NjI5OTR9.DQo37mNmTp_zzfZj_nY_EcvgvYzGztjeenQnZXsivxk' \
    -H 'Content-Type: application/json' \
    -d 'New organization name'

Device

Get device list

GET /devices
Request Parameters
Parameter Description

page

Page number

limit

Page size

locationId

Location id

connected

The device connect status

adminManageStatus

The device adminManageStatus

HTTP Request
GET /devices?page=1&limit=10&locationId=1&connected=false&adminManageStatus=&adminManageStatus= HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE
Content-Type: application/json
Host: localhost:8080
Response Fields
Path Type Description

page

Number

The current page number.

count

Number

The element count of the current page.

total_pages

Number

The total page number based on request page size.

total_count

Number

The total element count.

data[].id

Number

The device ID.

data[].create_time

String

The create time.

data[].update_time

String

The last update time.

data[].org_id

Number

The organization identifier, valid when enabling HIQ feature.

data[].serial_number

String

The device serial number, valid for all non-HAC devices.

data[].service_tag

String

The device service tag, valid for all HAC devices.

data[].mac_address

String

The The device MAC address.

data[].device_function

String

The device function, such as AP, Router, Switch, etc.

data[].product_type

String

The product type, such as: AP_230, BR_100, NX9600, etc.

data[].hostname

String

The device hostname.

data[].ip_address

String

The device IPv4 address.

data[].software_version

String

The device OS software version.

data[].device_admin_state

String

The device admin state.

data[].connected

Boolean

The device connection status.

data[].last_connect_time

String

The device last connect time

HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Length: 5741
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "page" : 2,
  "count" : 10,
  "data" : [ {
    "id" : 1,
    "hostname" : "PLAN-6216E1-0",
    "connected" : true,
    "create_time" : "2021-09-28T19:43:09.000+0000",
    "update_time" : "2021-09-28T19:43:09.000+0000",
    "org_id" : 10,
    "serial_number" : "62210155893239",
    "service_tag" : "",
    "mac_address" : "Qg7UpmIzXUzn",
    "device_function" : "DEVICE_FUNCTION_AP",
    "product_type" : "AP_230",
    "ip_address" : "192.168.56.0",
    "software_version" : "8.4.10.0",
    "device_admin_state" : "DEVICE_ADMIN_STATE_MANAGED",
    "last_connect_time" : "2021-09-28T19:43:09.000+0000"
  }, {
    "id" : 2,
    "hostname" : "PLAN-6216E1-1",
    "connected" : true,
    "create_time" : "2021-09-28T19:43:09.000+0000",
    "update_time" : "2021-09-28T19:43:09.000+0000",
    "org_id" : 10,
    "serial_number" : "81256205829492",
    "service_tag" : "",
    "mac_address" : "gKQGR3Im6eQ5",
    "device_function" : "DEVICE_FUNCTION_AP",
    "product_type" : "AP_230",
    "ip_address" : "192.168.56.1",
    "software_version" : "8.4.10.0",
    "device_admin_state" : "DEVICE_ADMIN_STATE_MANAGED",
    "last_connect_time" : "2021-09-28T19:43:09.000+0000"
  }, {
    "id" : 3,
    "hostname" : "PLAN-6216E1-2",
    "connected" : true,
    "create_time" : "2021-09-28T19:43:09.000+0000",
    "update_time" : "2021-09-28T19:43:09.000+0000",
    "org_id" : 10,
    "serial_number" : "80351111433927",
    "service_tag" : "",
    "mac_address" : "4LpdweyLsVGh",
    "device_function" : "DEVICE_FUNCTION_AP",
    "product_type" : "AP_230",
    "ip_address" : "192.168.56.2",
    "software_version" : "8.4.10.0",
    "device_admin_state" : "DEVICE_ADMIN_STATE_MANAGED",
    "last_connect_time" : "2021-09-28T19:43:09.000+0000"
  }, {
    "id" : 4,
    "hostname" : "PLAN-6216E1-3",
    "connected" : true,
    "create_time" : "2021-09-28T19:43:09.000+0000",
    "update_time" : "2021-09-28T19:43:09.000+0000",
    "org_id" : 10,
    "serial_number" : "22415256429470",
    "service_tag" : "",
    "mac_address" : "Q1P29WtW9VLL",
    "device_function" : "DEVICE_FUNCTION_AP",
    "product_type" : "AP_230",
    "ip_address" : "192.168.56.3",
    "software_version" : "8.4.10.0",
    "device_admin_state" : "DEVICE_ADMIN_STATE_MANAGED",
    "last_connect_time" : "2021-09-28T19:43:09.000+0000"
  }, {
    "id" : 5,
    "hostname" : "PLAN-6216E1-4",
    "connected" : true,
    "create_time" : "2021-09-28T19:43:09.000+0000",
    "update_time" : "2021-09-28T19:43:09.000+0000",
    "org_id" : 10,
    "serial_number" : "56619882104643",
    "service_tag" : "",
    "mac_address" : "IUV1evnfT3Vi",
    "device_function" : "DEVICE_FUNCTION_AP",
    "product_type" : "AP_230",
    "ip_address" : "192.168.56.4",
    "software_version" : "8.4.10.0",
    "device_admin_state" : "DEVICE_ADMIN_STATE_MANAGED",
    "last_connect_time" : "2021-09-28T19:43:09.000+0000"
  }, {
    "id" : 6,
    "hostname" : "PLAN-6216E1-5",
    "connected" : true,
    "create_time" : "2021-09-28T19:43:09.000+0000",
    "update_time" : "2021-09-28T19:43:09.000+0000",
    "org_id" : 10,
    "serial_number" : "41257814327364",
    "service_tag" : "",
    "mac_address" : "Tu3VNulBNmIy",
    "device_function" : "DEVICE_FUNCTION_AP",
    "product_type" : "AP_230",
    "ip_address" : "192.168.56.5",
    "software_version" : "8.4.10.0",
    "device_admin_state" : "DEVICE_ADMIN_STATE_MANAGED",
    "last_connect_time" : "2021-09-28T19:43:09.000+0000"
  }, {
    "id" : 7,
    "hostname" : "PLAN-6216E1-6",
    "connected" : true,
    "create_time" : "2021-09-28T19:43:09.000+0000",
    "update_time" : "2021-09-28T19:43:09.000+0000",
    "org_id" : 10,
    "serial_number" : "38633746769804",
    "service_tag" : "",
    "mac_address" : "5DV0H2nDNGdp",
    "device_function" : "DEVICE_FUNCTION_AP",
    "product_type" : "AP_230",
    "ip_address" : "192.168.56.6",
    "software_version" : "8.4.10.0",
    "device_admin_state" : "DEVICE_ADMIN_STATE_MANAGED",
    "last_connect_time" : "2021-09-28T19:43:09.000+0000"
  }, {
    "id" : 8,
    "hostname" : "PLAN-6216E1-7",
    "connected" : true,
    "create_time" : "2021-09-28T19:43:09.000+0000",
    "update_time" : "2021-09-28T19:43:09.000+0000",
    "org_id" : 10,
    "serial_number" : "25358526656048",
    "service_tag" : "",
    "mac_address" : "1Mcsgbae51N5",
    "device_function" : "DEVICE_FUNCTION_AP",
    "product_type" : "AP_230",
    "ip_address" : "192.168.56.7",
    "software_version" : "8.4.10.0",
    "device_admin_state" : "DEVICE_ADMIN_STATE_MANAGED",
    "last_connect_time" : "2021-09-28T19:43:09.000+0000"
  }, {
    "id" : 9,
    "hostname" : "PLAN-6216E1-8",
    "connected" : true,
    "create_time" : "2021-09-28T19:43:09.000+0000",
    "update_time" : "2021-09-28T19:43:09.000+0000",
    "org_id" : 10,
    "serial_number" : "93657812586583",
    "service_tag" : "",
    "mac_address" : "IOLxu2MwwtHb",
    "device_function" : "DEVICE_FUNCTION_AP",
    "product_type" : "AP_230",
    "ip_address" : "192.168.56.8",
    "software_version" : "8.4.10.0",
    "device_admin_state" : "DEVICE_ADMIN_STATE_MANAGED",
    "last_connect_time" : "2021-09-28T19:43:09.000+0000"
  }, {
    "id" : 10,
    "hostname" : "PLAN-6216E1-9",
    "connected" : true,
    "create_time" : "2021-09-28T19:43:09.000+0000",
    "update_time" : "2021-09-28T19:43:09.000+0000",
    "org_id" : 10,
    "serial_number" : "41797011258868",
    "service_tag" : "",
    "mac_address" : "7fWOVUkylnzA",
    "device_function" : "DEVICE_FUNCTION_AP",
    "product_type" : "AP_230",
    "ip_address" : "192.168.56.9",
    "software_version" : "8.4.10.0",
    "device_admin_state" : "DEVICE_ADMIN_STATE_MANAGED",
    "last_connect_time" : "2021-09-28T19:43:09.000+0000"
  } ],
  "total_pages" : 2,
  "total_count" : 15
}
cURL Request
$ curl 'http://localhost:8080/devices?page=1&limit=10&locationId=1&connected=false&adminManageStatus=&adminManageStatus=' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE' \
    -H 'Content-Type: application/json'

Get device details for one device

GET /devices/{id}
HTTP Request
GET /devices/1 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE
Content-Type: application/json
Host: localhost:8080
Path parameters
Table 6. /devices/{id}
Parameter Description

id

Device ID

Response Fields
Path Type Description

id

Number

The device ID.

create_time

String

The create time.

update_time

String

The last update time.

org_id

Number

The organization identifier, valid when enabling HIQ feature.

serial_number

String

The device serial number, valid for all non-HAC devices.

service_tag

String

The device service tag, valid for all HAC devices.

mac_address

String

The The device MAC address.

device_function

String

The device function, such as AP, Router, Switch, etc.

product_type

String

The product type, such as: AP_230, BR_100, NX9600, etc.

hostname

String

The device hostname.

ip_address

String

The device IPv4 address.

software_version

String

The device OS software version.

device_admin_state

String

The device admin state.

connected

Boolean

The device connection status.

last_connect_time

String

The device last connect time.

HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Content-Length: 531

{
  "id" : 1,
  "hostname" : "PLAN-6216E1-1",
  "connected" : true,
  "create_time" : "2021-09-28T19:43:09.000+0000",
  "update_time" : "2021-09-28T19:43:09.000+0000",
  "org_id" : 10,
  "serial_number" : "89199695151232",
  "service_tag" : "",
  "mac_address" : "D9U9CD02YJPb",
  "device_function" : "DEVICE_FUNCTION_AP",
  "product_type" : "AP_230",
  "ip_address" : "192.168.56.1",
  "software_version" : "8.4.10.0",
  "device_admin_state" : "DEVICE_ADMIN_STATE_MANAGED",
  "last_connect_time" : "1970-01-01T00:00:00.000+0000"
}
cURL Request
$ curl 'http://localhost:8080/devices/1' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE' \
    -H 'Content-Type: application/json'

Onboard devices

POST /devices/:onboard
HTTP Request
POST /devices/:onboard HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE
Content-Length: 309
Content-Type: application/json
Host: localhost:8080

{
  "extreme" : {
    "sns" : [ "zzzz-zzz-zzz" ]
  },
  "exos" : {
    "sns" : [ "zzzz-zzz-www" ]
  },
  "voss" : {
    "sns" : [ "zzzz-zzz-www" ]
  },
  "wing" : {
    "sn_to_mac" : {
      "serial_num" : "mac_address"
    }
  },
  "dell" : {
    "sn_to_st" : {
      "serial_num" : "service_tag"
    }
  }
}
HTTP Request Fields
Path Type Description

extreme.sns

Array

The serial numbers of Extreme/Aerohive devices to onboard.

exos.sns

Array

The serial numbers of ExtremeXOS (EXOS) devices to onboard.

voss.sns

Array

The serial numbers of VSP Operating System Software (VOSS) devices to onboard.

wing.sn_to_mac

Object

The serial number to MAC address mapping.

dell.sn_to_st

Object

The serial number to service tag mapping of Dell devices to onboard.

HTTP Request Body
{
  "extreme" : {
    "sns" : [ "zzzz-zzz-zzz" ]
  },
  "exos" : {
    "sns" : [ "zzzz-zzz-www" ]
  },
  "voss" : {
    "sns" : [ "zzzz-zzz-www" ]
  },
  "wing" : {
    "sn_to_mac" : {
      "serial_num" : "mac_address"
    }
  },
  "dell" : {
    "sn_to_st" : {
      "serial_num" : "service_tag"
    }
  }
}
HTTP Response
HTTP/1.1 202 Accepted
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
cURL Request
$ curl 'http://localhost:8080/devices/:onboard' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE' \
    -H 'Content-Type: application/json' \
    -d '{
  "extreme" : {
    "sns" : [ "zzzz-zzz-zzz" ]
  },
  "exos" : {
    "sns" : [ "zzzz-zzz-www" ]
  },
  "voss" : {
    "sns" : [ "zzzz-zzz-www" ]
  },
  "wing" : {
    "sn_to_mac" : {
      "serial_num" : "mac_address"
    }
  },
  "dell" : {
    "sn_to_st" : {
      "serial_num" : "service_tag"
    }
  }
}'

Delete devices

Delete devices by the given device ID list.

POST /devices/:delete
HTTP Request
POST /devices/:delete HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE
Host: localhost:8080
Content-Length: 25
Content-Type: application/json
Content-Type: application/json

{
  "ids" : [ 1, 2, 3 ]
}
HTTP Request Fields
Path Type Description

ids[]

Array

The device ID list.

HTTP Request Body
{
  "ids" : [ 1, 2, 3 ]
}
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
cURL Request
$ curl 'http://localhost:8080/devices/:delete' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE' \
    -H 'Content-Type: application/json' \
    -H 'Content-Type: application/json' \
    -d '{
  "ids" : [ 1, 2, 3 ]
}'

Delete device

Delete one device.

DELETE /devices/{id}
HTTP Request
DELETE /devices/2 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE
Content-Type: application/json
Host: localhost:8080
Path parameters
Table 7. /devices/{id}
Parameter Description

id

Device ID

HTTP Request Body
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
cURL Request
$ curl 'http://localhost:8080/devices/2' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE' \
    -H 'Content-Type: application/json'

Reboot devices

POST /devices/:reboot
HTTP Request
POST /devices/:reboot HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE
Content-Type: application/json
Host: localhost:8080
Content-Length: 25

{
  "ids" : [ 1, 2, 3 ]
}
HTTP Request Fields
Path Type Description

ids

Array

The device ID list.

HTTP Request Body
{
  "ids" : [ 1, 2, 3 ]
}
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
cURL Request
$ curl 'http://localhost:8080/devices/:reboot' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE' \
    -H 'Content-Type: application/json' \
    -d '{
  "ids" : [ 1, 2, 3 ]
}'

Reboot one device

POST /devices/{id}/:reboot
HTTP Request
POST /devices/1/:reboot HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE
Content-Type: application/json
Host: localhost:8080
Path parameters
Table 8. /devices/{id}/:reboot
Parameter Description

id

Device ID

HTTP Request Body
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
cURL Request
$ curl 'http://localhost:8080/devices/1/:reboot' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE' \
    -H 'Content-Type: application/json'

Send CLI

Send CLI to devices.

POST /devices/:cli
HTTP Request
POST /devices/:cli HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE
Content-Length: 95
Content-Type: application/json
Host: localhost:8080

{
  "devices" : {
    "ids" : [ 1, 2, 3 ]
  },
  "clis" : [ "CLI_to_send_1", "CLI_to_send2" ]
}
HTTP Request Fields
Path Type Description

clis

Array

The device ID list.

devices.ids

Array

The device ID list.

HTTP Request Body
{
  "devices" : {
    "ids" : [ 1, 2, 3 ]
  },
  "clis" : [ "CLI_to_send_1", "CLI_to_send2" ]
}
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
Content-Length: 32
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "device_cli_outputs" : { }
}
HTTP Response Fields
Path Type Description

device_cli_outputs

Object

device ID → CLI outputs

HTTP Response Body
{
  "device_cli_outputs" : { }
}
cURL Request
$ curl 'http://localhost:8080/devices/:cli' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE' \
    -H 'Content-Type: application/json' \
    -d '{
  "devices" : {
    "ids" : [ 1, 2, 3 ]
  },
  "clis" : [ "CLI_to_send_1", "CLI_to_send2" ]
}'

Send CLI to one device

Send CLI to one device.

POST /devices/{id}/:cli
HTTP Request
POST /devices/1/:cli HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE
Content-Type: application/json
Content-Length: 35
Host: localhost:8080

[ "CLI_to_send_1", "CLI_to_send2" ]
Path parameters
Table 9. /devices/{id}/:cli
Parameter Description

id

Device ID

HTTP Request Fields
Path Type Description

[]

Array

The request CLIs

HTTP Request Body
[ "CLI_to_send_1", "CLI_to_send2" ]
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
Content-Length: 32
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "device_cli_outputs" : { }
}
HTTP Response Body
{
  "device_cli_outputs" : { }
}
cURL Request
$ curl 'http://localhost:8080/devices/1/:cli' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE' \
    -H 'Content-Type: application/json' \
    -d '[ "CLI_to_send_1", "CLI_to_send2" ]'

Change status to Managed

Change device management status to Managed status.

POST /devices/:manage
HTTP Request
POST /devices/:unmanage HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE
Content-Type: application/json
Host: localhost:8080
Content-Length: 25

{
  "ids" : [ 1, 2, 3 ]
}
Request Fields
{
  "ids" : [ 1, 2, 3 ]
}
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
cURL Request
$ curl 'http://localhost:8080/devices/:unmanage' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE' \
    -H 'Content-Type: application/json' \
    -d '{
  "ids" : [ 1, 2, 3 ]
}'

Change status to Managed for one device

Change device management status to Managed status.

POST /devices/{id}/:manage
HTTP Request
POST /devices/1/:manage HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE
Content-Type: application/json
Host: localhost:8080
Path parameters
Table 10. /devices/{id}/:manage
Parameter Description

id

Device ID

Request Fields
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
cURL Request
$ curl 'http://localhost:8080/devices/1/:manage' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE' \
    -H 'Content-Type: application/json'

Change status to Unmanaged

Change device management status to Unmanaged status.

POST /devices/:unmanage
HTTP Request
POST /devices/:unmanage HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE
Content-Type: application/json
Host: localhost:8080
Content-Length: 25

{
  "ids" : [ 1, 2, 3 ]
}
Request Fields
Path Type Description

ids

Array

The device ID list.

HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
cURL Request
$ curl 'http://localhost:8080/devices/:unmanage' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE' \
    -H 'Content-Type: application/json' \
    -d '{
  "ids" : [ 1, 2, 3 ]
}'

Change status to Unmanaged for one device

Change device management status to Unmanaged status.

POST /devices/{id}/:unmanage
HTTP Request
POST /devices/1/:unmanage HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE
Content-Type: application/json
Host: localhost:8080
Path parameters
Table 11. /devices/{id}/:unmanage
Parameter Description

id

Device ID

HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
cURL Request
$ curl 'http://localhost:8080/devices/1/:unmanage' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE' \
    -H 'Content-Type: application/json'

Change hostname for one device

PUT /devices/{id}/hostname
HTTP Request
PUT /devices/1/hostname HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE
Content-Type: application/json
Host: localhost:8080

hostname=hostname_001
HTTP Request Parameters
Parameter Description

hostname

The new hostname

Path parameters
Table 12. /devices/{id}/hostname
Parameter Description

id

Device ID

HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
cURL Request
$ curl 'http://localhost:8080/devices/1/hostname' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE' \
    -H 'Content-Type: application/json' \
    -d 'hostname=hostname_001'

Push configuration and upgrade firmware to devices

POST /devices/config/:deploy
HTTP Request
POST /devices/config/:deploy HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg4LCJleHAiOjE2MzM0NjI5ODh9.yvZay2K2GqynsdUzmBpPXWsv6leWcgcMHfY58W75JCs
Content-Length: 405
Content-Type: application/json
Host: localhost:8080

{
  "devices" : {
    "ids" : [ 1, 2, 3 ]
  },
  "deploy_policy" : {
    "enable_complete_configuration_update" : false,
    "firmware_upgrade_policy" : {
      "enable_enforce_upgrade" : true,
      "enable_distributed_upgrade" : true
    },
    "firmware_activate_option" : {
      "enable_activate_at_next_reboot" : true,
      "activation_delay_seconds" : 30,
      "activation_time" : 600
    }
  }
}
HTTP Request Fields
Path Type Description

devices.ids[]

Array

The device ID list.

deploy_policy

Object

Configuration update type.

deploy_policy.firmware_upgrade_policy

Object

Firmware upgrade policy.

deploy_policy.firmware_activate_option

Object

Firmware activate option.

deploy_policy.firmware_upgrade_policy.enable_enforce_upgrade

Boolean

Whether enforce firmware upgrade even if the versions are the same.

deploy_policy.firmware_upgrade_policy.enable_distributed_upgrade

Boolean

Whether enable distributed firmware upgrade (Only applicable to APs).

deploy_policy.firmware_activate_option.enable_activate_at_next_reboot

Boolean

Activate at next reboot (requires rebooting manually).

deploy_policy.firmware_activate_option.activation_delay_seconds

Number

Activate after the given seconds.

deploy_policy.firmware_activate_option.activation_time

Number

Activate at the following time according to the system clock on the updated device.

HTTP Request Body
{
  "devices" : {
    "ids" : [ 1, 2, 3 ]
  },
  "deploy_policy" : {
    "enable_complete_configuration_update" : false,
    "firmware_upgrade_policy" : {
      "enable_enforce_upgrade" : true,
      "enable_distributed_upgrade" : true
    },
    "firmware_activate_option" : {
      "enable_activate_at_next_reboot" : true,
      "activation_delay_seconds" : 30,
      "activation_time" : 600
    }
  }
}
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Content-Length: 22
Expires: 0
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "request_id" : 1
}
HTTP Response Body
{
  "request_id" : 1
}
cURL Request
$ curl 'http://localhost:8080/devices/config/:deploy' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg4LCJleHAiOjE2MzM0NjI5ODh9.yvZay2K2GqynsdUzmBpPXWsv6leWcgcMHfY58W75JCs' \
    -H 'Content-Type: application/json' \
    -d '{
  "devices" : {
    "ids" : [ 1, 2, 3 ]
  },
  "deploy_policy" : {
    "enable_complete_configuration_update" : false,
    "firmware_upgrade_policy" : {
      "enable_enforce_upgrade" : true,
      "enable_distributed_upgrade" : true
    },
    "firmware_activate_option" : {
      "enable_activate_at_next_reboot" : true,
      "activation_delay_seconds" : 30,
      "activation_time" : 600
    }
  }
}'

Get configuration deployment overview

GET /devices/config/deploy/overview
HTTP Request
GET /devices/config/deploy/overview HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg4LCJleHAiOjE2MzM0NjI5ODh9.yvZay2K2GqynsdUzmBpPXWsv6leWcgcMHfY58W75JCs
Content-Type: application/json
Host: localhost:8080
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Content-Length: 57

{
  "in_progress_devices" : 10,
  "total_progress" : 50
}
HTTP Response Body
{
  "in_progress_devices" : 10,
  "total_progress" : 50
}
HTTP Response Fields
Path Type Description

in_progress_devices

Number

The device count with in progress deployment.

total_progress

Number

The total progress, range from 0 to 100.

cURL Request
$ curl 'http://localhost:8080/devices/config/deploy/overview' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg4LCJleHAiOjE2MzM0NjI5ODh9.yvZay2K2GqynsdUzmBpPXWsv6leWcgcMHfY58W75JCs' \
    -H 'Content-Type: application/json'
Get configuration deployment status
GET /devices/config/deploy/status
HTTP Request
GET /devices/config/deploy/status?deviceIds=1&deviceIds=2 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg4LCJleHAiOjE2MzM0NjI5ODh9.yvZay2K2GqynsdUzmBpPXWsv6leWcgcMHfY58W75JCs
Content-Type: application/json
Host: localhost:8080
HTTP Request Parameters
Parameter Description

deviceIds

The target device IDs

HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Content-Length: 217
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "1" : {
    "is_finished" : true,
    "current_progress" : null,
    "current_step_code" : null,
    "current_step_message" : null,
    "is_finished_successful" : true,
    "last_deploy_time" : 1632858188610
  }
}
HTTP Response Body
{
  "1" : {
    "is_finished" : true,
    "current_progress" : null,
    "current_step_code" : null,
    "current_step_message" : null,
    "is_finished_successful" : true,
    "last_deploy_time" : 1632858188610
  }
}
HTTP Response Fields
Path Type Description

*.is_finished

Boolean

Indicates whether the last deployment is finished.

*.current_progress

Null

The current deploy progress if not finished, range from 0 to 100.

*.current_step_code

Null

The code of the current deploy step if not finished.

*.current_step_message

Null

The readable message of the current deploy step if not finished.

*.is_finished_successful

Boolean

Indicates whether the last deployment is successful if finished.

*.last_deploy_time

Number

The last deployed time (Only valid when in_progress = false).

cURL Request
$ curl 'http://localhost:8080/devices/config/deploy/status?deviceIds=1&deviceIds=2' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg4LCJleHAiOjE2MzM0NjI5ODh9.yvZay2K2GqynsdUzmBpPXWsv6leWcgcMHfY58W75JCs' \
    -H 'Content-Type: application/json'

Query location for multiple devices

POST /devices/location/:query
HTTP Request
POST /devices/location/:query HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE
Content-Type: application/json
Host: localhost:8080
Content-Length: 25

{
  "ids" : [ 1, 2, 3 ]
}
HTTP Request Fields
Path Type Description

ids

Array

The device ID list.

HTTP Request Body
{
  "ids" : [ 1, 2, 3 ]
}
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Length: 424
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "1" : {
    "x" : 101.0,
    "y" : 0.0,
    "latitude" : 0.0,
    "longitude" : 0.0,
    "location_id" : 1,
    "create_time" : "2021-09-28T19:43:09.000+0000",
    "update_time" : "2021-09-28T19:43:09.000+0000",
    "org_id" : 0,
    "parent_id" : 0,
    "location_name" : "1st floor",
    "location_unique_name" : "Location_001_floor",
    "location_type" : "Standard",
    "location_address" : "Location address"
  }
}
HTTP Response Fields
Path Type Description

*.location_id

Number

The assigned location ID.

*.create_time

String

The timestamp when the device assigned to the location.

*.update_time

String

The timestamp when the location info was last updated.

*.org_id

Number

The organization ID.

*.parent_id

Number

The parent location ID.

*.location_name

String

The location name.

*.location_unique_name

String

The unique location name.

*.location_type

String

The address for the location.

*.location_address

String

The address for the location.

*.x

Number

The horizontal value in the floor map.

*.y

Number

The vertical value in the floor map.

*.latitude

Number

The latitude in the geography.

*.longitude

Number

The longitude in the geography.

HTTP Response Body
{
  "1" : {
    "x" : 101.0,
    "y" : 0.0,
    "latitude" : 0.0,
    "longitude" : 0.0,
    "location_id" : 1,
    "create_time" : "2021-09-28T19:43:09.000+0000",
    "update_time" : "2021-09-28T19:43:09.000+0000",
    "org_id" : 0,
    "parent_id" : 0,
    "location_name" : "1st floor",
    "location_unique_name" : "Location_001_floor",
    "location_type" : "Standard",
    "location_address" : "Location address"
  }
}
cURL Request
$ curl 'http://localhost:8080/devices/location/:query' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE' \
    -H 'Content-Type: application/json' \
    -d '{
  "ids" : [ 1, 2, 3 ]
}'

Get location for one device

GET /devices/{id}/location
HTTP Request
GET /devices/1/location HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE
Content-Type: application/json
Host: localhost:8080
Path parameters
Table 13. /devices/{id}/location
Parameter Description

id

Device ID

HTTP Response Fields
Path Type Description

location_id

Number

The assigned location ID.

create_time

String

The timestamp when the device assigned to the location.

update_time

String

The timestamp when the location info was last updated.

org_id

Number

The organization ID.

parent_id

Number

The parent location ID.

location_name

String

The location name.

location_unique_name

String

The unique location name.

location_type

String

The address for the location.

location_address

String

The address for the location.

x

Number

The horizontal value in the floor map.

y

Number

The vertical value in the floor map.

latitude

Number

The latitude in the geography.

longitude

Number

The longitude in the geography.

HTTP Response Body
{
  "x" : 101.0,
  "y" : 0.0,
  "latitude" : 0.0,
  "longitude" : 0.0,
  "location_id" : 1,
  "create_time" : "2021-09-28T19:43:09.000+0000",
  "update_time" : "2021-09-28T19:43:09.000+0000",
  "org_id" : 0,
  "parent_id" : 0,
  "location_name" : "1st floor",
  "location_unique_name" : "Location_001_floor",
  "location_type" : "Standard",
  "location_address" : "Location address"
}
cURL Request
$ curl 'http://localhost:8080/devices/1/location' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE' \
    -H 'Content-Type: application/json'

Assign location to multiple devices

POST /devices/location/:assgin
HTTP Request
POST /devices/location/:assign HTTP/1.1
Content-Length: 173
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg4LCJleHAiOjE2MzM0NjI5ODh9.yvZay2K2GqynsdUzmBpPXWsv6leWcgcMHfY58W75JCs
Content-Type: application/json
Host: localhost:8080

{
  "devices" : {
    "ids" : [ 1, 2, 3 ]
  },
  "device_location" : {
    "location_id" : 1,
    "x" : 0.0,
    "y" : 0.0,
    "latitude" : 0.0,
    "longitude" : 0.0
  }
}
HTTP Request Fields
Path Type Description

devices

Object

The devices filter

devices.ids

Array

The device ID list.

device_location

Object

The Device location assignment

device_location.location_id

Number

The assigned location ID.

device_location.x

Number

The horizontal value in the floor map.

device_location.y

Number

The vertical value in the floor map.

device_location.latitude

Number

The vertical value in the floor map.

device_location.longitude

Number

The longitude in the geography.

HTTP Request Body
{
  "devices" : {
    "ids" : [ 1, 2, 3 ]
  },
  "device_location" : {
    "location_id" : 1,
    "x" : 0.0,
    "y" : 0.0,
    "latitude" : 0.0,
    "longitude" : 0.0
  }
}
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
HTTP Response Body
cURL Request
$ curl 'http://localhost:8080/devices/location/:assign' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg4LCJleHAiOjE2MzM0NjI5ODh9.yvZay2K2GqynsdUzmBpPXWsv6leWcgcMHfY58W75JCs' \
    -H 'Content-Type: application/json' \
    -d '{
  "devices" : {
    "ids" : [ 1, 2, 3 ]
  },
  "device_location" : {
    "location_id" : 1,
    "x" : 0.0,
    "y" : 0.0,
    "latitude" : 0.0,
    "longitude" : 0.0
  }
}'

Assign location to one device

PUT /devices/{id}/location
HTTP Request
PUT /devices/1/location HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg4LCJleHAiOjE2MzM0NjI5ODh9.yvZay2K2GqynsdUzmBpPXWsv6leWcgcMHfY58W75JCs
Content-Length: 90
Content-Type: application/json
Host: localhost:8080

{
  "location_id" : 1,
  "x" : 0.0,
  "y" : 0.0,
  "latitude" : 0.0,
  "longitude" : 0.0
}
Path parameters
Table 14. /devices/{id}/location
Parameter Description

id

Device ID

HTTP Request Fields
Path Type Description

location_id

Number

The assigned location ID.

x

Number

The horizontal value in the floor map.

y

Number

The vertical value in the floor map.

latitude

Number

The vertical value in the floor map.

longitude

Number

The longitude in the geography.

HTTP Request Body
{
  "location_id" : 1,
  "x" : 0.0,
  "y" : 0.0,
  "latitude" : 0.0,
  "longitude" : 0.0
}
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
cURL Request
$ curl 'http://localhost:8080/devices/1/location' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg4LCJleHAiOjE2MzM0NjI5ODh9.yvZay2K2GqynsdUzmBpPXWsv6leWcgcMHfY58W75JCs' \
    -H 'Content-Type: application/json' \
    -d '{
  "location_id" : 1,
  "x" : 0.0,
  "y" : 0.0,
  "latitude" : 0.0,
  "longitude" : 0.0
}'

Revoke location for multiple devices

POST /devices/location/:revoke
HTTP Request
POST /devices/location/:revoke HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE
Content-Type: application/json
Host: localhost:8080
Content-Length: 25

{
  "ids" : [ 1, 2, 3 ]
}
HTTP Request Fields
Path Type Description

ids

Array

The device ID list.

HTTP Request Body
{
  "ids" : [ 1, 2, 3 ]
}
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
cURL Request
$ curl 'http://localhost:8080/devices/location/:revoke' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE' \
    -H 'Content-Type: application/json' \
    -d '{
  "ids" : [ 1, 2, 3 ]
}'

Revoke location for one device

DELETE /devices/{id}/location
HTTP Request
DELETE /devices/1/location HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE
Content-Type: application/json
Host: localhost:8080
Path parameters
Table 15. /devices/{id}/location
Parameter Description

id

Device ID

HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
HTTP Response Body
cURL Request
$ curl 'http://localhost:8080/devices/1/location' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE' \
    -H 'Content-Type: application/json'

Query network policy for multiple devices

POST /devices/network-policy/:query
HTTP Request
POST /devices/network-policy/:query HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg4LCJleHAiOjE2MzM0NjI5ODh9.yvZay2K2GqynsdUzmBpPXWsv6leWcgcMHfY58W75JCs
Content-Type: application/json
Host: localhost:8080
Content-Length: 25

{
  "ids" : [ 1, 2, 3 ]
}
HTTP Request Fields
Path Type Description

ids

Array

The device ID list.

HTTP Request Body
{
  "ids" : [ 1, 2, 3 ]
}
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Length: 424
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "1" : {
    "x" : 101.0,
    "y" : 0.0,
    "latitude" : 0.0,
    "longitude" : 0.0,
    "location_id" : 1,
    "create_time" : "2021-09-28T19:43:09.000+0000",
    "update_time" : "2021-09-28T19:43:09.000+0000",
    "org_id" : 0,
    "parent_id" : 0,
    "location_name" : "1st floor",
    "location_unique_name" : "Location_001_floor",
    "location_type" : "Standard",
    "location_address" : "Location address"
  }
}
HTTP Response Fields
Path Type Description

*.location_id

Number

The assigned location ID.

*.create_time

String

The timestamp when the device assigned to the location.

*.update_time

String

The timestamp when the location info was last updated.

*.org_id

Number

The organization ID.

*.parent_id

Number

The parent location ID.

*.location_name

String

The location name.

*.location_unique_name

String

The unique location name.

*.location_type

String

The address for the location.

*.location_address

String

The address for the location.

*.x

Number

The horizontal value in the floor map.

*.y

Number

The vertical value in the floor map.

*.latitude

Number

The latitude in the geography.

*.longitude

Number

The longitude in the geography.

HTTP Response Body
{
  "1" : {
    "x" : 101.0,
    "y" : 0.0,
    "latitude" : 0.0,
    "longitude" : 0.0,
    "location_id" : 1,
    "create_time" : "2021-09-28T19:43:09.000+0000",
    "update_time" : "2021-09-28T19:43:09.000+0000",
    "org_id" : 0,
    "parent_id" : 0,
    "location_name" : "1st floor",
    "location_unique_name" : "Location_001_floor",
    "location_type" : "Standard",
    "location_address" : "Location address"
  }
}
cURL Request
$ curl 'http://localhost:8080/devices/location/:query' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE' \
    -H 'Content-Type: application/json' \
    -d '{
  "ids" : [ 1, 2, 3 ]
}'

Get network policy for one device

GET /devices/{id}/network-policy
HTTP Request
GET /devices/1/network-policy HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg4LCJleHAiOjE2MzM0NjI5ODh9.yvZay2K2GqynsdUzmBpPXWsv6leWcgcMHfY58W75JCs
Content-Type: application/json
Host: localhost:8080
Path parameters
Table 16. /devices/{id}/network-policy
Parameter Description

id

Device ID

HTTP Response Body
{
  "id" : 1,
  "name" : "Policy_001",
  "description" : "The description of network policy",
  "predefined" : false,
  "type" : "NetworkAccessAndSwitching",
  "create_time" : "2021-09-28T19:43:08.000+0000",
  "update_time" : "2021-09-28T19:43:08.000+0000",
  "org_id" : 0
}
cURL Request
$ curl 'http://localhost:8080/devices/1/network-policy' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg4LCJleHAiOjE2MzM0NjI5ODh9.yvZay2K2GqynsdUzmBpPXWsv6leWcgcMHfY58W75JCs' \
    -H 'Content-Type: application/json'

Assign network policy to multiple devices

POST /devices/network-policy/:assgin
HTTP Request
POST /devices/network-policy/:assign HTTP/1.1
Content-Length: 74
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE
Content-Type: application/json
Host: localhost:8080

{
  "devices" : {
    "ids" : [ 1, 2, 3 ]
  },
  "network_policy_id" : 1
}
HTTP Request Fields
Path Type Description

devices

Object

The devices filter

devices.ids

Array

The device ID list.

network_policy_id

Number

The assigned network policy ID

HTTP Request Body
{
  "devices" : {
    "ids" : [ 1, 2, 3 ]
  },
  "network_policy_id" : 1
}
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
HTTP Response Body
cURL Request
$ curl 'http://localhost:8080/devices/network-policy/:assign' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE' \
    -H 'Content-Type: application/json' \
    -d '{
  "devices" : {
    "ids" : [ 1, 2, 3 ]
  },
  "network_policy_id" : 1
}'

Assign network policy to one device

PUT /devices/{id}/network-policy
HTTP Request
PUT /devices/1/network-policy HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE
Content-Type: application/json
Host: localhost:8080

networkPolicyId=1
Path parameters
Table 17. /devices/{id}/network-policy
Parameter Description

id

Device ID

HTTP Request Body
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
cURL Request
$ curl 'http://localhost:8080/devices/1/network-policy' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE' \
    -H 'Content-Type: application/json' \
    -d 'networkPolicyId=1'

Revoke network policy for multiple devices

POST /devices/network-policy/:revoke
HTTP Request
POST /devices/location/:revoke HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE
Content-Type: application/json
Host: localhost:8080
Content-Length: 25

{
  "ids" : [ 1, 2, 3 ]
}
HTTP Request Fields
Path Type Description

ids

Array

The device ID list.

HTTP Request Body
{
  "ids" : [ 1, 2, 3 ]
}
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
cURL Request
$ curl 'http://localhost:8080/devices/location/:revoke' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE' \
    -H 'Content-Type: application/json' \
    -d '{
  "ids" : [ 1, 2, 3 ]
}'

Revoke network policy for one device

DELETE /devices/{id}/network-policy
HTTP Request
DELETE /devices/1/network-policy HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE
Content-Type: application/json
Host: localhost:8080
Path parameters
Table 18. /devices/{id}/network-policy
Parameter Description

id

Device ID

HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
HTTP Response Body
cURL Request
$ curl 'http://localhost:8080/devices/1/network-policy' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTg5LCJleHAiOjE2MzM0NjI5ODl9.Cjw1rp3E-2pB2yRtIaKPih2DtBk811oQEJR7uXWzRyE' \
    -H 'Content-Type: application/json'

Client

Get client list

GET /clients
HTTP Request
GET /clients/active HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTk2LCJleHAiOjE2MzM0NjI5OTZ9.ybsotoTEhqfNMuCfwFkjMsgtnb9z2PBrcKyavVJrJ48
Content-Type: application/json
Host: localhost:8080
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
Content-Length: 3295
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "page" : 2,
  "count" : 10,
  "data" : [ {
    "id" : 0,
    "hostname" : "Hostname 1",
    "username" : "",
    "connected" : true,
    "vlan" : 1,
    "ssid" : "SSID 1",
    "port" : "22",
    "create_time" : "2021-09-28T19:43:17.000+0000",
    "update_time" : "2021-09-28T19:43:17.000+0000",
    "org_id" : 0,
    "location_id" : 1,
    "device_id" : 1,
    "mac_address" : "ti3mMD5m0G0F",
    "ip_address" : "192.168.56.1",
    "ipv6_address" : "0000:0000:0000:0000:0000:0000:0000:0000 ",
    "os_type" : "Mac",
    "user_profile_name" : "",
    "online_time" : "2021-09-28T19:43:16.000+0000",
    "offline_time" : "2021-09-28T19:43:17.000+0000",
    "connection_type" : 0
  }, {
    "id" : 2,
    "hostname" : "Hostname 3",
    "username" : "",
    "connected" : true,
    "vlan" : 1,
    "ssid" : "SSID 3",
    "port" : "22",
    "create_time" : "2021-09-28T19:43:17.000+0000",
    "update_time" : "2021-09-28T19:43:17.000+0000",
    "org_id" : 0,
    "location_id" : 1,
    "device_id" : 1,
    "mac_address" : "Bp7CPJWmjlvB",
    "ip_address" : "192.168.56.3",
    "ipv6_address" : "0000:0000:0000:0000:0000:0000:0000:0000 ",
    "os_type" : "Mac",
    "user_profile_name" : "",
    "online_time" : "2021-09-28T19:43:16.000+0000",
    "offline_time" : "2021-09-28T19:43:17.000+0000",
    "connection_type" : 0
  }, {
    "id" : 4,
    "hostname" : "Hostname 5",
    "username" : "",
    "connected" : true,
    "vlan" : 1,
    "ssid" : "SSID 5",
    "port" : "22",
    "create_time" : "2021-09-28T19:43:17.000+0000",
    "update_time" : "2021-09-28T19:43:17.000+0000",
    "org_id" : 0,
    "location_id" : 1,
    "device_id" : 1,
    "mac_address" : "p2Osi3EYP1UU",
    "ip_address" : "192.168.56.5",
    "ipv6_address" : "0000:0000:0000:0000:0000:0000:0000:0000 ",
    "os_type" : "Mac",
    "user_profile_name" : "",
    "online_time" : "2021-09-28T19:43:16.000+0000",
    "offline_time" : "2021-09-28T19:43:17.000+0000",
    "connection_type" : 0
  }, {
    "id" : 6,
    "hostname" : "Hostname 7",
    "username" : "",
    "connected" : true,
    "vlan" : 1,
    "ssid" : "SSID 7",
    "port" : "22",
    "create_time" : "2021-09-28T19:43:17.000+0000",
    "update_time" : "2021-09-28T19:43:17.000+0000",
    "org_id" : 0,
    "location_id" : 1,
    "device_id" : 1,
    "mac_address" : "fcE70UgMuFnr",
    "ip_address" : "192.168.56.7",
    "ipv6_address" : "0000:0000:0000:0000:0000:0000:0000:0000 ",
    "os_type" : "Mac",
    "user_profile_name" : "",
    "online_time" : "2021-09-28T19:43:16.000+0000",
    "offline_time" : "2021-09-28T19:43:17.000+0000",
    "connection_type" : 0
  }, {
    "id" : 8,
    "hostname" : "Hostname 9",
    "username" : "",
    "connected" : true,
    "vlan" : 1,
    "ssid" : "SSID 9",
    "port" : "22",
    "create_time" : "2021-09-28T19:43:17.000+0000",
    "update_time" : "2021-09-28T19:43:17.000+0000",
    "org_id" : 0,
    "location_id" : 1,
    "device_id" : 1,
    "mac_address" : "uSgVkwVaIxCe",
    "ip_address" : "192.168.56.9",
    "ipv6_address" : "0000:0000:0000:0000:0000:0000:0000:0000 ",
    "os_type" : "Mac",
    "user_profile_name" : "",
    "online_time" : "2021-09-28T19:43:16.000+0000",
    "offline_time" : "2021-09-28T19:43:17.000+0000",
    "connection_type" : 0
  } ],
  "total_pages" : 2,
  "total_count" : 15
}
cURL Request
$ curl 'http://localhost:8080/clients/active' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTk2LCJleHAiOjE2MzM0NjI5OTZ9.ybsotoTEhqfNMuCfwFkjMsgtnb9z2PBrcKyavVJrJ48' \
    -H 'Content-Type: application/json'

Get client details

GET /clients/{id}

Get client summary

GET /clients/summary
Request Parameters
Parameter Description

locationIds

The location IDss

deviceIds

The device IDs

vlans

The associate VLAN IDs

userProfileNames

The user profile names

ssids

The SSIDs

HTTP Request
GET /clients/summary?deviceIds=100&vlans=1&userProfileNames=user1&locationIds=1&ssids=Extreme HTTP/1.1
Content-Type: application/json
Host: localhost:8080
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTk3LCJleHAiOjE2MzM0NjI5OTd9.tpsJ7lZ1NFkTMPZ0h3UgrbFyykE8jQ4o8c9VxZ-kFp0
Response Fields
Path Type Description

connected_wireless_client_count

Number

The connected wireless clients count.

detected_wired_client_count

Number

The detected wired clients count.

HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Content-Length: 80
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "connected_wireless_client_count" : 0,
  "detected_wired_client_count" : 0
}
cURL Request
$ curl 'http://localhost:8080/clients/summary?deviceIds=100&vlans=1&userProfileNames=user1&locationIds=1&ssids=Extreme' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTk3LCJleHAiOjE2MzM0NjI5OTd9.tpsJ7lZ1NFkTMPZ0h3UgrbFyykE8jQ4o8c9VxZ-kFp0'

Configuration

Configuration - Location

Get location tree
GET /locations/tree
HTTP Request
GET /locations/tree?parentId=1&expandChildren=true HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTk2LCJleHAiOjE2MzM0NjI5OTZ9.ybsotoTEhqfNMuCfwFkjMsgtnb9z2PBrcKyavVJrJ48
Content-Type: application/json
Host: localhost:8080
Request Body
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
Content-Length: 828
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

[ {
  "id" : 1,
  "name" : "Extreme",
  "type" : "",
  "address" : "",
  "children" : [ {
    "id" : 10,
    "name" : "Extreme_000",
    "type" : "",
    "address" : "",
    "children" : [ ],
    "create_time" : "2021-09-28T19:43:16.000+0000",
    "update_time" : "2021-09-28T19:43:16.000+0000",
    "org_id" : 0,
    "parent_id" : 1,
    "unique_name" : "Extreme_000"
  }, {
    "id" : 11,
    "name" : "Extreme_001",
    "type" : "",
    "address" : "",
    "children" : [ ],
    "create_time" : "2021-09-28T19:43:16.000+0000",
    "update_time" : "2021-09-28T19:43:16.000+0000",
    "org_id" : 0,
    "parent_id" : 1,
    "unique_name" : "Extreme_001"
  } ],
  "create_time" : "2021-09-28T19:43:16.000+0000",
  "update_time" : "2021-09-28T19:43:16.000+0000",
  "org_id" : 0,
  "parent_id" : 0,
  "unique_name" : "Extreme"
} ]
HTTP Response Body
[ {
  "id" : 1,
  "name" : "Extreme",
  "type" : "",
  "address" : "",
  "children" : [ {
    "id" : 10,
    "name" : "Extreme_000",
    "type" : "",
    "address" : "",
    "children" : [ ],
    "create_time" : "2021-09-28T19:43:16.000+0000",
    "update_time" : "2021-09-28T19:43:16.000+0000",
    "org_id" : 0,
    "parent_id" : 1,
    "unique_name" : "Extreme_000"
  }, {
    "id" : 11,
    "name" : "Extreme_001",
    "type" : "",
    "address" : "",
    "children" : [ ],
    "create_time" : "2021-09-28T19:43:16.000+0000",
    "update_time" : "2021-09-28T19:43:16.000+0000",
    "org_id" : 0,
    "parent_id" : 1,
    "unique_name" : "Extreme_001"
  } ],
  "create_time" : "2021-09-28T19:43:16.000+0000",
  "update_time" : "2021-09-28T19:43:16.000+0000",
  "org_id" : 0,
  "parent_id" : 0,
  "unique_name" : "Extreme"
} ]
HTTP Response Fields
Path Type Description

[].id

Number

The location ID.

[].create_time

String

The timestamp when the location was created.

[].update_time

String

The timestamp when the location was last updated.

[].org_id

Number

The organization ID.

[].parent_id

Number

The parent location ID.

[].name

String

The location name.

[].unique_name

String

The unique location name.

[].type

String

The location type.

[].address

String

The address for the location.

[].children

Array

The child locations.

cURL Request
$ curl 'http://localhost:8080/locations/tree?parentId=1&expandChildren=true' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTk2LCJleHAiOjE2MzM0NjI5OTZ9.ybsotoTEhqfNMuCfwFkjMsgtnb9z2PBrcKyavVJrJ48' \
    -H 'Content-Type: application/json'

Configuration - Network Policy

List network policies
GET /network-policies
HTTP Request
GET /network-policies?page=1&limit=10 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTk2LCJleHAiOjE2MzM0NjI5OTZ9.ybsotoTEhqfNMuCfwFkjMsgtnb9z2PBrcKyavVJrJ48
Content-Type: application/json
Host: localhost:8080
Request Parameters
Parameter Description

page

Page number

limit

Page size

HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Length: 604
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "page" : 2,
  "count" : 2,
  "data" : [ {
    "id" : 10,
    "name" : "Policy_000",
    "description" : "Test network policy",
    "predefined" : false,
    "type" : "AP",
    "create_time" : "2021-09-28T19:43:16.000+0000",
    "update_time" : "2021-09-28T19:43:16.000+0000",
    "org_id" : 0
  }, {
    "id" : 11,
    "name" : "Policy_001",
    "description" : "Test network policy",
    "predefined" : false,
    "type" : "AP",
    "create_time" : "2021-09-28T19:43:16.000+0000",
    "update_time" : "2021-09-28T19:43:16.000+0000",
    "org_id" : 0
  } ],
  "total_pages" : 1,
  "total_count" : 2
}
HTTP Response Body
{
  "page" : 2,
  "count" : 2,
  "data" : [ {
    "id" : 10,
    "name" : "Policy_000",
    "description" : "Test network policy",
    "predefined" : false,
    "type" : "AP",
    "create_time" : "2021-09-28T19:43:16.000+0000",
    "update_time" : "2021-09-28T19:43:16.000+0000",
    "org_id" : 0
  }, {
    "id" : 11,
    "name" : "Policy_001",
    "description" : "Test network policy",
    "predefined" : false,
    "type" : "AP",
    "create_time" : "2021-09-28T19:43:16.000+0000",
    "update_time" : "2021-09-28T19:43:16.000+0000",
    "org_id" : 0
  } ],
  "total_pages" : 1,
  "total_count" : 2
}
HTTP Response Fields
Path Type Description

page

Number

The current page number.

count

Number

The element count of the current page.

total_pages

Number

The total page number based on request page size.

total_count

Number

The total element count.

data[].id

Number

The network policy ID.

data[].create_time

String

The timestamp when the network policy was created.

data[].update_time

String

The timestamp when the network policy was last updated.

data[].org_id

Number

The Organization ID.

data[].name

String

The network policy name.

data[].description

String

The network policy description.

data[].predefined

Boolean

Whether it is a predefined or not.

data[].type

String

The network policy type.

cURL Request
$ curl 'http://localhost:8080/network-policies?page=1&limit=10' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTk2LCJleHAiOjE2MzM0NjI5OTZ9.ybsotoTEhqfNMuCfwFkjMsgtnb9z2PBrcKyavVJrJ48' \
    -H 'Content-Type: application/json'
List SSID list for the network policy
GET /network-policies/{id}/ssids
HTTP Request
GET /network-policies/1/ssids?page=1&limit=10 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTk2LCJleHAiOjE2MzM0NjI5OTZ9.ybsotoTEhqfNMuCfwFkjMsgtnb9z2PBrcKyavVJrJ48
Content-Type: application/json
Host: localhost:8080
Request Parameters
Parameter Description

page

Page number

limit

Page size

HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Content-Length: 562
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "page" : 1,
  "count" : 0,
  "data" : [ {
    "id" : 10,
    "name" : "SSID_000",
    "description" : "Test network policy",
    "predefined" : false,
    "create_time" : "2021-09-28T19:43:16.000+0000",
    "update_time" : "2021-09-28T19:43:16.000+0000",
    "org_id" : 0
  }, {
    "id" : 11,
    "name" : "SSID_001",
    "description" : "Test network policy",
    "predefined" : false,
    "create_time" : "2021-09-28T19:43:16.000+0000",
    "update_time" : "2021-09-28T19:43:16.000+0000",
    "org_id" : 0
  } ],
  "total_pages" : 0,
  "total_count" : 0
}
HTTP Response Body
{
  "page" : 1,
  "count" : 0,
  "data" : [ {
    "id" : 10,
    "name" : "SSID_000",
    "description" : "Test network policy",
    "predefined" : false,
    "create_time" : "2021-09-28T19:43:16.000+0000",
    "update_time" : "2021-09-28T19:43:16.000+0000",
    "org_id" : 0
  }, {
    "id" : 11,
    "name" : "SSID_001",
    "description" : "Test network policy",
    "predefined" : false,
    "create_time" : "2021-09-28T19:43:16.000+0000",
    "update_time" : "2021-09-28T19:43:16.000+0000",
    "org_id" : 0
  } ],
  "total_pages" : 0,
  "total_count" : 0
}
HTTP Response Fields
Path Type Description

page

Number

The current page number.

count

Number

The element count of the current page.

total_pages

Number

The total page number based on request page size.

total_count

Number

The total element count.

data[].id

Number

The SSID ID.

data[].create_time

String

The timestamp when the network policy was created.

data[].update_time

String

The timestamp when the network policy was last updated.

data[].org_id

Number

The Organization ID.

data[].name

String

The SSID name or SSID broadcast name.

data[].description

String

The SSID description.

data[].predefined

Boolean

Whether it is predefined.

cURL Request
$ curl 'http://localhost:8080/network-policies/1/ssids?page=1&limit=10' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTk2LCJleHAiOjE2MzM0NjI5OTZ9.ybsotoTEhqfNMuCfwFkjMsgtnb9z2PBrcKyavVJrJ48' \
    -H 'Content-Type: application/json'

Configuration - SSID

List SSIDs
GET /ssids
HTTP Request
GET /ssids?page=1&limit=10 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTk2LCJleHAiOjE2MzM0NjI5OTZ9.ybsotoTEhqfNMuCfwFkjMsgtnb9z2PBrcKyavVJrJ48
Content-Type: application/json
Host: localhost:8080
Request Parameters
Parameter Description

page

Page number

limit

Page size

HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Content-Length: 554

{
  "page" : 2,
  "count" : 2,
  "data" : [ {
    "id" : 10,
    "name" : "SSID_000",
    "description" : "The WIFI SSID 0",
    "predefined" : false,
    "create_time" : "2021-09-28T19:43:16.000+0000",
    "update_time" : "2021-09-28T19:43:16.000+0000",
    "org_id" : 0
  }, {
    "id" : 11,
    "name" : "SSID_001",
    "description" : "The WIFI SSID 1",
    "predefined" : false,
    "create_time" : "2021-09-28T19:43:16.000+0000",
    "update_time" : "2021-09-28T19:43:16.000+0000",
    "org_id" : 0
  } ],
  "total_pages" : 1,
  "total_count" : 2
}
HTTP Response Body
{
  "page" : 2,
  "count" : 2,
  "data" : [ {
    "id" : 10,
    "name" : "SSID_000",
    "description" : "The WIFI SSID 0",
    "predefined" : false,
    "create_time" : "2021-09-28T19:43:16.000+0000",
    "update_time" : "2021-09-28T19:43:16.000+0000",
    "org_id" : 0
  }, {
    "id" : 11,
    "name" : "SSID_001",
    "description" : "The WIFI SSID 1",
    "predefined" : false,
    "create_time" : "2021-09-28T19:43:16.000+0000",
    "update_time" : "2021-09-28T19:43:16.000+0000",
    "org_id" : 0
  } ],
  "total_pages" : 1,
  "total_count" : 2
}
HTTP Response Fields
Path Type Description

page

Number

The current page number.

count

Number

The element count of the current page.

total_pages

Number

The total page number based on request page size.

total_count

Number

The total element count.

data[].id

Number

The SSID ID.

data[].create_time

String

The timestamp when the network policy was created.

data[].update_time

String

The timestamp when the network policy was last updated.

data[].org_id

Number

The Organization ID.

data[].name

String

The SSID name or SSID broadcast name.

data[].description

String

The SSID description.

data[].predefined

Boolean

Whether it is predefined.

cURL Request
$ curl 'http://localhost:8080/ssids?page=1&limit=10' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTk2LCJleHAiOjE2MzM0NjI5OTZ9.ybsotoTEhqfNMuCfwFkjMsgtnb9z2PBrcKyavVJrJ48' \
    -H 'Content-Type: application/json'
Rename SSID(Wireless name)
POST /ssids/{id}/:rename
HTTP Request
POST /ssids/1/:rename HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTk2LCJleHAiOjE2MzM0NjI5OTZ9.ybsotoTEhqfNMuCfwFkjMsgtnb9z2PBrcKyavVJrJ48
Content-Type: application/json
Content-Length: 12
Host: localhost:8080

"'NEW NAME'"
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
HTTP Response Body
cURL Request
$ curl 'http://localhost:8080/ssids/1/:rename' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTk2LCJleHAiOjE2MzM0NjI5OTZ9.ybsotoTEhqfNMuCfwFkjMsgtnb9z2PBrcKyavVJrJ48' \
    -H 'Content-Type: application/json' \
    -d '"'NEW NAME'"'

Configuration - PCG (Key-Based)

Initiate Key Based PCG

Initiate Key Based PCG network Policy, include initiate user, user group, SSID and Key Based PCGentry data

POST /pcg/key-based
Request Fields
Path Type Description

policy_name

String

The network policy name.

ssid_name

String

The SSID name

users

Array

The key based PCG users

users[].name

String

The user name

users[].email

String

The user email to deliver password

users[].user_group_name

String

The key based PCG user group name

HTTP Request
POST /pcg/key-based HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkwLCJleHAiOjE2MzM0NjI5OTB9.Pt-Ne1pxkFs-okQjFGKCcCk-MqkyisS-iBUJ_A1WRAw
Content-Length: 190
Host: localhost:8080
Content-Type: application/json
Content-Type: application/json

{
  "policy_name" : "PCG_policy",
  "ssid_name" : "PCG_wifi",
  "users" : [ {
    "name" : "candy",
    "email" : "candy@extremecloudiq.com",
    "user_group_name" : "room-201-group"
  } ]
}
HTTP Response
HTTP/1.1 202 Accepted
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
cURL Request
$ curl 'http://localhost:8080/pcg/key-based' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkwLCJleHAiOjE2MzM0NjI5OTB9.Pt-Ne1pxkFs-okQjFGKCcCk-MqkyisS-iBUJ_A1WRAw' \
    -H 'Content-Type: application/json' \
    -H 'Content-Type: application/json' \
    -d '{
  "policy_name" : "PCG_policy",
  "ssid_name" : "PCG_wifi",
  "users" : [ {
    "name" : "candy",
    "email" : "candy@extremecloudiq.com",
    "user_group_name" : "room-201-group"
  } ]
}'
List all Key Based PCG entries
GET /pcg/key-based
HTTP Request
GET /pcg/key-based HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkwLCJleHAiOjE2MzM0NjI5OTB9.Pt-Ne1pxkFs-okQjFGKCcCk-MqkyisS-iBUJ_A1WRAw
Content-Type: application/json
Host: localhost:8080
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
Content-Length: 5507
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

[ {
  "id" : 1,
  "owner_id" : 102,
  "enabled" : true,
  "create_time" : "2021-09-28T19:43:10.000+0000",
  "update_time" : "2021-09-28T19:43:10.000+0000",
  "org_id" : 10,
  "policy_id" : 0,
  "policy_name" : "pcg_1",
  "ssid_name" : "ssid_1",
  "users" : [ {
    "name" : "pcg_user1",
    "email" : "pcg_user_1@extremecloudiq.com",
    "id" : 0,
    "owner_id" : 102,
    "user_group_name" : "pcg_user_group",
    "create_time" : "2021-09-28T19:43:10.000+0000",
    "update_time" : "2021-09-28T19:43:10.000+0000",
    "org_id" : 10
  }, {
    "name" : "pcg_user2",
    "email" : "pcg_user_2@extremecloudiq.com",
    "id" : 1,
    "owner_id" : 102,
    "user_group_name" : "pcg_user_group",
    "create_time" : "2021-09-28T19:43:10.000+0000",
    "update_time" : "2021-09-28T19:43:10.000+0000",
    "org_id" : 10
  }, {
    "name" : "pcg_user3",
    "email" : "pcg_user_3@extremecloudiq.com",
    "id" : 2,
    "owner_id" : 102,
    "user_group_name" : "pcg_user_group",
    "create_time" : "2021-09-28T19:43:10.000+0000",
    "update_time" : "2021-09-28T19:43:10.000+0000",
    "org_id" : 10
  } ]
}, {
  "id" : 2,
  "owner_id" : 102,
  "enabled" : true,
  "create_time" : "2021-09-28T19:43:10.000+0000",
  "update_time" : "2021-09-28T19:43:10.000+0000",
  "org_id" : 10,
  "policy_id" : 1,
  "policy_name" : "pcg_2",
  "ssid_name" : "ssid_2",
  "users" : [ {
    "name" : "pcg_user1",
    "email" : "pcg_user_1@extremecloudiq.com",
    "id" : 0,
    "owner_id" : 102,
    "user_group_name" : "pcg_user_group",
    "create_time" : "2021-09-28T19:43:10.000+0000",
    "update_time" : "2021-09-28T19:43:10.000+0000",
    "org_id" : 10
  }, {
    "name" : "pcg_user2",
    "email" : "pcg_user_2@extremecloudiq.com",
    "id" : 1,
    "owner_id" : 102,
    "user_group_name" : "pcg_user_group",
    "create_time" : "2021-09-28T19:43:10.000+0000",
    "update_time" : "2021-09-28T19:43:10.000+0000",
    "org_id" : 10
  }, {
    "name" : "pcg_user3",
    "email" : "pcg_user_3@extremecloudiq.com",
    "id" : 2,
    "owner_id" : 102,
    "user_group_name" : "pcg_user_group",
    "create_time" : "2021-09-28T19:43:10.000+0000",
    "update_time" : "2021-09-28T19:43:10.000+0000",
    "org_id" : 10
  } ]
}, {
  "id" : 3,
  "owner_id" : 102,
  "enabled" : true,
  "create_time" : "2021-09-28T19:43:10.000+0000",
  "update_time" : "2021-09-28T19:43:10.000+0000",
  "org_id" : 10,
  "policy_id" : 2,
  "policy_name" : "pcg_3",
  "ssid_name" : "ssid_3",
  "users" : [ {
    "name" : "pcg_user1",
    "email" : "pcg_user_1@extremecloudiq.com",
    "id" : 0,
    "owner_id" : 102,
    "user_group_name" : "pcg_user_group",
    "create_time" : "2021-09-28T19:43:10.000+0000",
    "update_time" : "2021-09-28T19:43:10.000+0000",
    "org_id" : 10
  }, {
    "name" : "pcg_user2",
    "email" : "pcg_user_2@extremecloudiq.com",
    "id" : 1,
    "owner_id" : 102,
    "user_group_name" : "pcg_user_group",
    "create_time" : "2021-09-28T19:43:10.000+0000",
    "update_time" : "2021-09-28T19:43:10.000+0000",
    "org_id" : 10
  }, {
    "name" : "pcg_user3",
    "email" : "pcg_user_3@extremecloudiq.com",
    "id" : 2,
    "owner_id" : 102,
    "user_group_name" : "pcg_user_group",
    "create_time" : "2021-09-28T19:43:10.000+0000",
    "update_time" : "2021-09-28T19:43:10.000+0000",
    "org_id" : 10
  } ]
}, {
  "id" : 4,
  "owner_id" : 102,
  "enabled" : true,
  "create_time" : "2021-09-28T19:43:10.000+0000",
  "update_time" : "2021-09-28T19:43:10.000+0000",
  "org_id" : 10,
  "policy_id" : 3,
  "policy_name" : "pcg_4",
  "ssid_name" : "ssid_4",
  "users" : [ {
    "name" : "pcg_user1",
    "email" : "pcg_user_1@extremecloudiq.com",
    "id" : 0,
    "owner_id" : 102,
    "user_group_name" : "pcg_user_group",
    "create_time" : "2021-09-28T19:43:10.000+0000",
    "update_time" : "2021-09-28T19:43:10.000+0000",
    "org_id" : 10
  }, {
    "name" : "pcg_user2",
    "email" : "pcg_user_2@extremecloudiq.com",
    "id" : 1,
    "owner_id" : 102,
    "user_group_name" : "pcg_user_group",
    "create_time" : "2021-09-28T19:43:10.000+0000",
    "update_time" : "2021-09-28T19:43:10.000+0000",
    "org_id" : 10
  }, {
    "name" : "pcg_user3",
    "email" : "pcg_user_3@extremecloudiq.com",
    "id" : 2,
    "owner_id" : 102,
    "user_group_name" : "pcg_user_group",
    "create_time" : "2021-09-28T19:43:10.000+0000",
    "update_time" : "2021-09-28T19:43:10.000+0000",
    "org_id" : 10
  } ]
}, {
  "id" : 5,
  "owner_id" : 102,
  "enabled" : true,
  "create_time" : "2021-09-28T19:43:10.000+0000",
  "update_time" : "2021-09-28T19:43:10.000+0000",
  "org_id" : 10,
  "policy_id" : 4,
  "policy_name" : "pcg_5",
  "ssid_name" : "ssid_5",
  "users" : [ {
    "name" : "pcg_user1",
    "email" : "pcg_user_1@extremecloudiq.com",
    "id" : 0,
    "owner_id" : 102,
    "user_group_name" : "pcg_user_group",
    "create_time" : "2021-09-28T19:43:10.000+0000",
    "update_time" : "2021-09-28T19:43:10.000+0000",
    "org_id" : 10
  }, {
    "name" : "pcg_user2",
    "email" : "pcg_user_2@extremecloudiq.com",
    "id" : 1,
    "owner_id" : 102,
    "user_group_name" : "pcg_user_group",
    "create_time" : "2021-09-28T19:43:10.000+0000",
    "update_time" : "2021-09-28T19:43:10.000+0000",
    "org_id" : 10
  }, {
    "name" : "pcg_user3",
    "email" : "pcg_user_3@extremecloudiq.com",
    "id" : 2,
    "owner_id" : 102,
    "user_group_name" : "pcg_user_group",
    "create_time" : "2021-09-28T19:43:10.000+0000",
    "update_time" : "2021-09-28T19:43:10.000+0000",
    "org_id" : 10
  } ]
} ]
cURL Request
$ curl 'http://localhost:8080/pcg/key-based' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkwLCJleHAiOjE2MzM0NjI5OTB9.Pt-Ne1pxkFs-okQjFGKCcCk-MqkyisS-iBUJ_A1WRAw' \
    -H 'Content-Type: application/json'
Get Key Based PCG users from given network policy ID
GET /pcg/key-based/{policyId}/users
Path Parameters
Table 19. /pcg/key-based/{policyId}/users
Parameter Description

policyId

The network policy ID

HTTP Request
GET /pcg/key-based/1/users HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkwLCJleHAiOjE2MzM0NjI5OTB9.Pt-Ne1pxkFs-okQjFGKCcCk-MqkyisS-iBUJ_A1WRAw
Content-Type: application/json
Host: localhost:8080
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Length: 788
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

[ {
  "name" : "pcg_user1",
  "email" : "pcg_user_1@extremecloudiq.com",
  "id" : 0,
  "owner_id" : 102,
  "user_group_name" : "pcg_user_group",
  "create_time" : "2021-09-28T19:43:10.000+0000",
  "update_time" : "2021-09-28T19:43:10.000+0000",
  "org_id" : 10
}, {
  "name" : "pcg_user2",
  "email" : "pcg_user_2@extremecloudiq.com",
  "id" : 1,
  "owner_id" : 102,
  "user_group_name" : "pcg_user_group",
  "create_time" : "2021-09-28T19:43:10.000+0000",
  "update_time" : "2021-09-28T19:43:10.000+0000",
  "org_id" : 10
}, {
  "name" : "pcg_user3",
  "email" : "pcg_user_3@extremecloudiq.com",
  "id" : 2,
  "owner_id" : 102,
  "user_group_name" : "pcg_user_group",
  "create_time" : "2021-09-28T19:43:10.000+0000",
  "update_time" : "2021-09-28T19:43:10.000+0000",
  "org_id" : 10
} ]
cURL Request
$ curl 'http://localhost:8080/pcg/key-based/1/users' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkwLCJleHAiOjE2MzM0NjI5OTB9.Pt-Ne1pxkFs-okQjFGKCcCk-MqkyisS-iBUJ_A1WRAw' \
    -H 'Content-Type: application/json'
Add Key Based PCG users to an exists Key Based PCG
POST /pcg/key-based/{policyId}/users
Path Parameters
Table 20. /pcg/key-based/{policyId}/users
Parameter Description

policyId

The network policy ID

Request Fields
Path Type Description

users

Array

The key based PCG users

users[].name

String

The user name

users[].email

String

The user email to deliver password

users[].user_group_name

String

The key based PCG user group name

HTTP Request
POST /pcg/key-based/1/users HTTP/1.1
Content-Length: 130
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkwLCJleHAiOjE2MzM0NjI5OTB9.Pt-Ne1pxkFs-okQjFGKCcCk-MqkyisS-iBUJ_A1WRAw
Host: localhost:8080
Content-Type: application/json
Content-Type: application/json

{
  "users" : [ {
    "name" : "candy",
    "email" : "candy@extremecloudiq.com",
    "user_group_name" : "room-201-group"
  } ]
}
HTTP Response
HTTP/1.1 202 Accepted
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
cURL Request
$ curl 'http://localhost:8080/pcg/key-based/1/users' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkwLCJleHAiOjE2MzM0NjI5OTB9.Pt-Ne1pxkFs-okQjFGKCcCk-MqkyisS-iBUJ_A1WRAw' \
    -H 'Content-Type: application/json' \
    -H 'Content-Type: application/json' \
    -d '{
  "users" : [ {
    "name" : "candy",
    "email" : "candy@extremecloudiq.com",
    "user_group_name" : "room-201-group"
  } ]
}'
Replace all Key Based PCG users
PUT /pcg/key-based/{policyId}/users
Path Parameters
Table 21. /pcg/key-based/{policyId}/users
Parameter Description

policyId

The network policy ID

Request Fields
Path Type Description

users

Array

The key based PCG users

users[].name

String

The user name

users[].email

String

The user email to deliver password

users[].user_group_name

String

The key based PCG user group name

HTTP Request
PUT /pcg/key-based/1/users HTTP/1.1
Content-Length: 130
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkwLCJleHAiOjE2MzM0NjI5OTB9.Pt-Ne1pxkFs-okQjFGKCcCk-MqkyisS-iBUJ_A1WRAw
Host: localhost:8080
Content-Type: application/json
Content-Type: application/json

{
  "users" : [ {
    "name" : "candy",
    "email" : "candy@extremecloudiq.com",
    "user_group_name" : "room-201-group"
  } ]
}
HTTP Response
HTTP/1.1 202 Accepted
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
cURL Request
$ curl 'http://localhost:8080/pcg/key-based/1/users' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkwLCJleHAiOjE2MzM0NjI5OTB9.Pt-Ne1pxkFs-okQjFGKCcCk-MqkyisS-iBUJ_A1WRAw' \
    -H 'Content-Type: application/json' \
    -H 'Content-Type: application/json' \
    -d '{
  "users" : [ {
    "name" : "candy",
    "email" : "candy@extremecloudiq.com",
    "user_group_name" : "room-201-group"
  } ]
}'
Delete Key Based PCG users
DELETE /pcg/key-based/{policyId}/users
Path Parameters
Table 22. /pcg/key-based/{policyId}/users
Parameter Description

policyId

The network policy ID

Request Fields
Path Type Description

user_ids

Array

The key based PCG user IDs

HTTP Request
DELETE /pcg/key-based/1/users HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkwLCJleHAiOjE2MzM0NjI5OTB9.Pt-Ne1pxkFs-okQjFGKCcCk-MqkyisS-iBUJ_A1WRAw
Content-Length: 27
Host: localhost:8080
Content-Type: application/json
Content-Type: application/json

{
  "user_ids" : [ 1, 2 ]
}
HTTP Response
HTTP/1.1 202 Accepted
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
cURL Request
$ curl 'http://localhost:8080/pcg/key-based/1/users' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkwLCJleHAiOjE2MzM0NjI5OTB9.Pt-Ne1pxkFs-okQjFGKCcCk-MqkyisS-iBUJ_A1WRAw' \
    -H 'Content-Type: application/json' \
    -H 'Content-Type: application/json' \
    -d '{
  "user_ids" : [ 1, 2 ]
}'
Create Key Based PCG Data

Create Key Based PCG entry from exist network policy, SSID profile and users.

POST /pcg/key-based/{policyId}/:onboard
Path Parameters
Table 23. /pcg/key-based/{policyId}/:onboard
Parameter Description

policyId

The network policy ID

Request Fields
Path Type Description

ssid_name

String

The SSID name.

enabled

Boolean

The flag to enable/disable key based PCG

user_ids[]

Array

The user ids to enable the key based PCG

Request Body
{
  "enabled" : true,
  "ssid_name" : "PCG_wifi",
  "user_ids" : [ 1 ]
}
HTTP Request
POST /pcg/key-based/1/:onboard HTTP/1.1
Content-Length: 72
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkwLCJleHAiOjE2MzM0NjI5OTB9.Pt-Ne1pxkFs-okQjFGKCcCk-MqkyisS-iBUJ_A1WRAw
Host: localhost:8080
Content-Type: application/json
Content-Type: application/json

{
  "enabled" : true,
  "ssid_name" : "PCG_wifi",
  "user_ids" : [ 1 ]
}
HTTP Response
HTTP/1.1 202 Accepted
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
cURL Request
$ curl 'http://localhost:8080/pcg/key-based/1/:onboard' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkwLCJleHAiOjE2MzM0NjI5OTB9.Pt-Ne1pxkFs-okQjFGKCcCk-MqkyisS-iBUJ_A1WRAw' \
    -H 'Content-Type: application/json' \
    -H 'Content-Type: application/json' \
    -d '{
  "enabled" : true,
  "ssid_name" : "PCG_wifi",
  "user_ids" : [ 1 ]
}'
Delete Key Based PCG

Delete Key Based PCG from network policy

DELETE /pcg/key-based/{policyId}
Path Parameters
Table 24. /pcg/key-based/{policyId}
Parameter Description

policyId

The network policy ID

Request Parameters
Parameter Description

ids

The IDs of the Key Based PCG entity to be deleted from network policy

HTTP Request
DELETE /pcg/key-based/1 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkwLCJleHAiOjE2MzM0NjI5OTB9.Pt-Ne1pxkFs-okQjFGKCcCk-MqkyisS-iBUJ_A1WRAw
Content-Type: application/json
Host: localhost:8080
HTTP Response
HTTP/1.1 202 Accepted
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
cURL Request
$ curl 'http://localhost:8080/pcg/key-based/1' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkwLCJleHAiOjE2MzM0NjI5OTB9.Pt-Ne1pxkFs-okQjFGKCcCk-MqkyisS-iBUJ_A1WRAw' \
    -H 'Content-Type: application/json'
Generate keys

Generate keys for Key Based PCG users

POST /pcg/key-based/{policyId}/keys/:generate
Path Parameters
Table 25. /pcg/key-based/{policyId}/keys/:generate
Parameter Description

policyId

The network policy ID

HTTP Request
POST /pcg/key-based/1/keys/:generate HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkwLCJleHAiOjE2MzM0NjI5OTB9.Pt-Ne1pxkFs-okQjFGKCcCk-MqkyisS-iBUJ_A1WRAw
Content-Type: application/json
Host: localhost:8080

userIds=1&userIds=2&userIds=3
HTTP Response
HTTP/1.1 202 Accepted
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
cURL Request
$ curl 'http://localhost:8080/pcg/key-based/1/keys/:generate' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkwLCJleHAiOjE2MzM0NjI5OTB9.Pt-Ne1pxkFs-okQjFGKCcCk-MqkyisS-iBUJ_A1WRAw' \
    -H 'Content-Type: application/json' \
    -d 'userIds=1&userIds=2&userIds=3'
Email keys

Email keys for Key Based PCG users

POST /pcg/key-based/{policyId}/keys/:email
Path Parameters
Table 26. /pcg/key-based/{policyId}/keys/:email
Parameter Description

policyId

The network policy ID

HTTP Request
POST /pcg/key-based/1/keys/:email HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkwLCJleHAiOjE2MzM0NjI5OTB9.Pt-Ne1pxkFs-okQjFGKCcCk-MqkyisS-iBUJ_A1WRAw
Content-Type: application/json
Host: localhost:8080

userIds=1&userIds=2&userIds=3
HTTP Response
HTTP/1.1 202 Accepted
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
cURL Request
$ curl 'http://localhost:8080/pcg/key-based/1/keys/:email' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkwLCJleHAiOjE2MzM0NjI5OTB9.Pt-Ne1pxkFs-okQjFGKCcCk-MqkyisS-iBUJ_A1WRAw' \
    -H 'Content-Type: application/json' \
    -d 'userIds=1&userIds=2&userIds=3'
Assign ports for AP150W
POST /pcg/key-based/ports/{policyId}
Path Parameters
Table 27. /pcg/key-based/ports/{policyId}
Parameter Description

policyId

The network policy ID

Request Fields
Path Type Description

pcg_port_assignment[]

Array

The port assignment array.

pcg_port_assignment[].device_id

Number

The device ID of AP150W

pcg_port_assignment[].eth1_user_id

Number

The user ID of eth1

pcg_port_assignment[].eth2_user_id

Number

The user ID of eth2

pcg_port_assignment[].eth3_user_id

Number

The user ID of eth3

Request Body
{
  "pcg_port_assignment" : [ {
    "device_id" : 1,
    "eth1_user_id" : 1,
    "eth2_user_id" : 2,
    "eth3_user_id" : 3
  }, {
    "device_id" : 1,
    "eth1_user_id" : 1,
    "eth2_user_id" : 2,
    "eth3_user_id" : 3
  }, {
    "device_id" : 1,
    "eth1_user_id" : 1,
    "eth2_user_id" : 2,
    "eth3_user_id" : 3
  } ]
}
HTTP Request
POST /pcg/key-based/ports/1 HTTP/1.1
Content-Length: 329
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkwLCJleHAiOjE2MzM0NjI5OTB9.Pt-Ne1pxkFs-okQjFGKCcCk-MqkyisS-iBUJ_A1WRAw
Host: localhost:8080
Content-Type: application/json
Content-Type: application/json

{
  "pcg_port_assignment" : [ {
    "device_id" : 1,
    "eth1_user_id" : 1,
    "eth2_user_id" : 2,
    "eth3_user_id" : 3
  }, {
    "device_id" : 1,
    "eth1_user_id" : 1,
    "eth2_user_id" : 2,
    "eth3_user_id" : 3
  }, {
    "device_id" : 1,
    "eth1_user_id" : 1,
    "eth2_user_id" : 2,
    "eth3_user_id" : 3
  } ]
}
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Length: 348
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "policy_id" : 1,
  "policy_name" : "PCG_policy",
  "pcg_port_assignment_entries" : [ {
    "id" : 1,
    "create_time" : "2021-09-28T19:43:10.000+0000",
    "update_time" : "2021-09-28T19:43:10.000+0000",
    "owner_id" : 102,
    "org_id" : 0,
    "device_id" : 1,
    "eth1_user_id" : 1,
    "eth2_user_id" : 2,
    "eth3_user_id" : 3
  } ]
}
cURL Request
$ curl 'http://localhost:8080/pcg/key-based/ports/1' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkwLCJleHAiOjE2MzM0NjI5OTB9.Pt-Ne1pxkFs-okQjFGKCcCk-MqkyisS-iBUJ_A1WRAw' \
    -H 'Content-Type: application/json' \
    -H 'Content-Type: application/json' \
    -d '{
  "pcg_port_assignment" : [ {
    "device_id" : 1,
    "eth1_user_id" : 1,
    "eth2_user_id" : 2,
    "eth3_user_id" : 3
  }, {
    "device_id" : 1,
    "eth1_user_id" : 1,
    "eth2_user_id" : 2,
    "eth3_user_id" : 3
  }, {
    "device_id" : 1,
    "eth1_user_id" : 1,
    "eth2_user_id" : 2,
    "eth3_user_id" : 3
  } ]
}'
Get port assignment details of AP150W
GET /pcg/key-based/ports/{policyId}
Path Parameters
Table 28. /pcg/key-based/ports/{policyId}
Parameter Description

policyId

The network policy ID

HTTP Request
GET /pcg/key-based/ports/1 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkwLCJleHAiOjE2MzM0NjI5OTB9.Pt-Ne1pxkFs-okQjFGKCcCk-MqkyisS-iBUJ_A1WRAw
Content-Type: application/json
Host: localhost:8080
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Content-Length: 1601

{
  "policy_id" : 1,
  "policy_name" : "PCG_policy",
  "pcg_port_assignment_entries" : [ {
    "id" : 1,
    "owner_id" : 102,
    "create_time" : "2021-09-28T19:43:10.000+0000",
    "update_time" : "2021-09-28T19:43:10.000+0000",
    "org_id" : 0,
    "device" : {
      "id" : 1,
      "owner_id" : 102,
      "create_time" : "2021-09-28T19:43:10.000+0000",
      "update_time" : "2021-09-28T19:43:10.000+0000",
      "org_id" : 0,
      "mac_address" : "xxxxxxxx",
      "serial_number" : "xxx-xxx-xxx",
      "product_type" : "AP"
    },
    "eth1" : {
      "id" : 1,
      "owner_id" : 102,
      "name" : "user_1",
      "password" : "xxxxxx",
      "ssids" : [ "ssid_1" ],
      "create_time" : "2021-09-28T19:43:10.000+0000",
      "update_time" : "2021-09-28T19:43:10.000+0000",
      "org_id" : 0,
      "user_type" : "LOCAL_PPSK",
      "user_group_name" : "pcg_user_group"
    },
    "eth2" : {
      "id" : 2,
      "owner_id" : 102,
      "name" : "user_1",
      "password" : "xxxxxx",
      "ssids" : [ "ssid_2" ],
      "create_time" : "2021-09-28T19:43:10.000+0000",
      "update_time" : "2021-09-28T19:43:10.000+0000",
      "org_id" : 0,
      "user_type" : "LOCAL_PPSK",
      "user_group_name" : "pcg_user_group"
    },
    "eth3" : {
      "id" : 3,
      "owner_id" : 102,
      "name" : "user_1",
      "password" : "xxxxxx",
      "ssids" : [ "ssid_2" ],
      "create_time" : "2021-09-28T19:43:10.000+0000",
      "update_time" : "2021-09-28T19:43:10.000+0000",
      "org_id" : 0,
      "user_type" : "LOCAL_PPSK",
      "user_group_name" : "pcg_user_group"
    }
  } ]
}
cURL Request
$ curl 'http://localhost:8080/pcg/key-based/ports/1' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkwLCJleHAiOjE2MzM0NjI5OTB9.Pt-Ne1pxkFs-okQjFGKCcCk-MqkyisS-iBUJ_A1WRAw' \
    -H 'Content-Type: application/json'

Webhook - Subscription

List webhook subscriptions

GET /webhook/subscription
HTTP Request
GET /subscriptions/webhook HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkwLCJleHAiOjE2MzM0NjI5OTB9.Pt-Ne1pxkFs-okQjFGKCcCk-MqkyisS-iBUJ_A1WRAw
Content-Type: application/json
Host: localhost:8080
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Length: 3623
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

[ {
  "id" : 1,
  "application" : "foo_0",
  "url" : "https://foo.com/pMonv",
  "secret" : "xNzsxnNYWd",
  "status" : "SUBSCRIPTION_STATUS_ENABLED",
  "create_time" : "2021-09-28T19:43:10.000+0000",
  "update_time" : "2021-09-28T19:43:10.000+0000",
  "data_type" : "SUBSCRIPTION_DATA_TYPE_LOCATION",
  "message_type" : "SUBSCRIPTION_MESSAGE_TYPE_AUDIT_LOG_ALL"
}, {
  "id" : 2,
  "application" : "foo_1",
  "url" : "https://foo.com/SjaPc",
  "secret" : "UyNtOOPTow",
  "status" : "SUBSCRIPTION_STATUS_ENABLED",
  "create_time" : "2021-09-28T19:43:10.000+0000",
  "update_time" : "2021-09-28T19:43:10.000+0000",
  "data_type" : "SUBSCRIPTION_DATA_TYPE_LOCATION",
  "message_type" : "SUBSCRIPTION_MESSAGE_TYPE_AUDIT_LOG_ALL"
}, {
  "id" : 3,
  "application" : "foo_2",
  "url" : "https://foo.com/AuGbt",
  "secret" : "tV2HirF5kj",
  "status" : "SUBSCRIPTION_STATUS_ENABLED",
  "create_time" : "2021-09-28T19:43:10.000+0000",
  "update_time" : "2021-09-28T19:43:10.000+0000",
  "data_type" : "SUBSCRIPTION_DATA_TYPE_LOCATION",
  "message_type" : "SUBSCRIPTION_MESSAGE_TYPE_AUDIT_LOG_ALL"
}, {
  "id" : 4,
  "application" : "foo_3",
  "url" : "https://foo.com/mIDAw",
  "secret" : "NejVZUQJeR",
  "status" : "SUBSCRIPTION_STATUS_ENABLED",
  "create_time" : "2021-09-28T19:43:10.000+0000",
  "update_time" : "2021-09-28T19:43:10.000+0000",
  "data_type" : "SUBSCRIPTION_DATA_TYPE_LOCATION",
  "message_type" : "SUBSCRIPTION_MESSAGE_TYPE_AUDIT_LOG_ALL"
}, {
  "id" : 5,
  "application" : "foo_4",
  "url" : "https://foo.com/bRvLy",
  "secret" : "4ZNDRRYjyH",
  "status" : "SUBSCRIPTION_STATUS_ENABLED",
  "create_time" : "2021-09-28T19:43:10.000+0000",
  "update_time" : "2021-09-28T19:43:10.000+0000",
  "data_type" : "SUBSCRIPTION_DATA_TYPE_LOCATION",
  "message_type" : "SUBSCRIPTION_MESSAGE_TYPE_AUDIT_LOG_ALL"
}, {
  "id" : 6,
  "application" : "foo_5",
  "url" : "https://foo.com/dKHSo",
  "secret" : "cyRqMgWfhM",
  "status" : "SUBSCRIPTION_STATUS_ENABLED",
  "create_time" : "2021-09-28T19:43:10.000+0000",
  "update_time" : "2021-09-28T19:43:10.000+0000",
  "data_type" : "SUBSCRIPTION_DATA_TYPE_LOCATION",
  "message_type" : "SUBSCRIPTION_MESSAGE_TYPE_AUDIT_LOG_ALL"
}, {
  "id" : 7,
  "application" : "foo_6",
  "url" : "https://foo.com/HzpDW",
  "secret" : "1bOwa8Jydl",
  "status" : "SUBSCRIPTION_STATUS_ENABLED",
  "create_time" : "2021-09-28T19:43:10.000+0000",
  "update_time" : "2021-09-28T19:43:10.000+0000",
  "data_type" : "SUBSCRIPTION_DATA_TYPE_LOCATION",
  "message_type" : "SUBSCRIPTION_MESSAGE_TYPE_AUDIT_LOG_ALL"
}, {
  "id" : 8,
  "application" : "foo_7",
  "url" : "https://foo.com/kfnPU",
  "secret" : "kRAtca1hAR",
  "status" : "SUBSCRIPTION_STATUS_ENABLED",
  "create_time" : "2021-09-28T19:43:10.000+0000",
  "update_time" : "2021-09-28T19:43:10.000+0000",
  "data_type" : "SUBSCRIPTION_DATA_TYPE_LOCATION",
  "message_type" : "SUBSCRIPTION_MESSAGE_TYPE_AUDIT_LOG_ALL"
}, {
  "id" : 9,
  "application" : "foo_8",
  "url" : "https://foo.com/GUdOg",
  "secret" : "IynFw4qKS1",
  "status" : "SUBSCRIPTION_STATUS_ENABLED",
  "create_time" : "2021-09-28T19:43:10.000+0000",
  "update_time" : "2021-09-28T19:43:10.000+0000",
  "data_type" : "SUBSCRIPTION_DATA_TYPE_LOCATION",
  "message_type" : "SUBSCRIPTION_MESSAGE_TYPE_AUDIT_LOG_ALL"
}, {
  "id" : 10,
  "application" : "foo_9",
  "url" : "https://foo.com/ZdPXR",
  "secret" : "WK8mxLGEDl",
  "status" : "SUBSCRIPTION_STATUS_ENABLED",
  "create_time" : "2021-09-28T19:43:10.000+0000",
  "update_time" : "2021-09-28T19:43:10.000+0000",
  "data_type" : "SUBSCRIPTION_DATA_TYPE_LOCATION",
  "message_type" : "SUBSCRIPTION_MESSAGE_TYPE_AUDIT_LOG_ALL"
} ]
cURL Request
$ curl 'http://localhost:8080/subscriptions/webhook' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkwLCJleHAiOjE2MzM0NjI5OTB9.Pt-Ne1pxkFs-okQjFGKCcCk-MqkyisS-iBUJ_A1WRAw' \
    -H 'Content-Type: application/json'

Create webhook subscriptions

POST /webhook/subscription
Request Fields
Path Type Description

[]

Array

The webhook subscriptions info

[].application

String

The external application name.

[].url

String

The external application URL.

[].secret

String

The external subscriber basic auth secret.

[].message_type

String

The subscription message type.

HTTP Request
POST /subscriptions/webhook HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkwLCJleHAiOjE2MzM0NjI5OTB9.Pt-Ne1pxkFs-okQjFGKCcCk-MqkyisS-iBUJ_A1WRAw
Content-Length: 150
Host: localhost:8080
Content-Type: application/json
Content-Type: application/json

[ {
  "application" : "Mock subscriber",
  "url" : "http://localhost:8080/api/auditlog",
  "secret" : "xxxxxx",
  "message_type" : "AUDIT_LOG_ALL"
} ]
HTTP Response
HTTP/1.1 202 Accepted
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
cURL Request
$ curl 'http://localhost:8080/subscriptions/webhook' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkwLCJleHAiOjE2MzM0NjI5OTB9.Pt-Ne1pxkFs-okQjFGKCcCk-MqkyisS-iBUJ_A1WRAw' \
    -H 'Content-Type: application/json' \
    -H 'Content-Type: application/json' \
    -d '[ {
  "application" : "Mock subscriber",
  "url" : "http://localhost:8080/api/auditlog",
  "secret" : "xxxxxx",
  "message_type" : "AUDIT_LOG_ALL"
} ]'

Delete webhook subscriptions

DELETE /webhook/subscription/{subscriptionId}
Path Parameters
Table 29. /subscriptions/webhook/{subscriptionId}
Parameter Description

subscriptionId

The webhook subscription ID

HTTP Request
DELETE /subscriptions/webhook/1 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkwLCJleHAiOjE2MzM0NjI5OTB9.Pt-Ne1pxkFs-okQjFGKCcCk-MqkyisS-iBUJ_A1WRAw
Host: localhost:8080
Content-Type: application/json
Content-Type: application/json
HTTP Response
HTTP/1.1 202 Accepted
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
cURL Request
$ curl 'http://localhost:8080/subscriptions/webhook/1' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwibmV0d29yay1wb2xpY3k6ciIsInNzaWQiLCJzc2lkOnIiLCJwY2cta2V5LWJhc2VkIiwicGNnLWtleS1iYXNlZDpyIiwic3Vic2NyaXB0aW9ucy13ZWJob29rIiwic3Vic2NyaXB0aW9ucy13ZWJob29rOnIiLCJjY2ciLCJjY2c6ciIsImxvZ3MiLCJsb2dzOnIiXSwiY3VzdG9tZXJJZCI6MSwiY3VzdG9tZXJNb2RlIjowLCJoaXFFbmFibGVkIjp0cnVlLCJvcmdJZCI6MCwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjMyODU4MTkwLCJleHAiOjE2MzM0NjI5OTB9.Pt-Ne1pxkFs-okQjFGKCcCk-MqkyisS-iBUJ_A1WRAw' \
    -H 'Content-Type: application/json' \
    -H 'Content-Type: application/json'

Release Notes

This section summarizes the changes in each release.

Version 1.0 - 09/10/2020

The initial release covers the ExtremeCloud IQ core features.

Authentication
  • Support username/password authentication

Authorization
  • Fine-grained and flexible access control

  • Generate new API Token

  • Show user permissions

  • Permission check

Account
  • Get XIQ Account basic information

  • Get VIQ information

User
  • Get user profile

HIQ
  • Get HIQ status

  • Enable HIQ

  • Organization management

  • Switch HIQ context

Device
  • Get device list

  • Get device details

  • Device onboarding

  • Delete device

  • Send CLI to device

  • Reboot device

  • Push configuration

  • Switch device management status

Monitoring
  • Get client list

  • Get client details