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
X-Content-Type-Options: nosniff
Content-Length: 786
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "access_token" : "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU1LCJleHAiOjE2MDEyODM4NTV9.zUQqT_ZhdCEPW8Vb8O1AnlTF0tUY3cq88NkUgqK8kFw"
}
Unsuccessful Login Response
HTTP/1.1 401 Unauthorized
Content-Length: 151
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

{
  "timestamp" : "2020-09-21T02:04:15.822",
  "status" : 401,
  "error" : "10002",
  "message" : "Invalid username or password",
  "path" : "/login"
}

Authorization

Generate API Token

POST /auth/apitoken
Request fields
Path Type Description

description

String

Create API token description.

permissions

Array

The token permissions

expire_time

Number

The expire timestamp, if null means no expiration. Format is the number of seconds since January 1, 1970, 00:00:00 GMT

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

{
  "description" : "API Token for account read.",
  "expire_time" : 1600682659,
  "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" : "2020-09-21T09:04:19.000+0000",
  "expire_time" : "2020-09-21T10:04:19.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 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU5LCJleHAiOjE2MDEyODM4NTl9.NJpcdYWvEBgFxPrcmTFbVd1XlrChj5L4XgXn1ac0Q2Q' \
    -d '{
  "description" : "API Token for account read.",
  "expire_time" : 1600682659,
  "permissions" : [ "write*:auth" ]
}'

Get API Token details

GET /auth/apitoken/info
HTTP Request
GET /auth/apitoken/info HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU5LCJleHAiOjE2MDEyODM4NTl9.NJpcdYWvEBgFxPrcmTFbVd1XlrChj5L4XgXn1ac0Q2Q
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
Content-Length: 660
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

{
  "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" ],
  "issued_at" : "2020-09-21T09:04:19.000+0000",
  "expiration_time" : "2020-09-28T09:04:19.000+0000",
  "expires_in" : 604799
}
cURL request
$ curl 'http://localhost:8080/auth/apitoken/info' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU5LCJleHAiOjE2MDEyODM4NTl9.NJpcdYWvEBgFxPrcmTFbVd1XlrChj5L4XgXn1ac0Q2Q'

Get user permissions

GET /auth/permissions
HTTP Request
GET /auth/permissions HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU5LCJleHAiOjE2MDEyODM4NTl9.NJpcdYWvEBgFxPrcmTFbVd1XlrChj5L4XgXn1ac0Q2Q
Host: localhost:8080
HTTP Response
HTTP/1.1 200 OK
Content-Length: 3153
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

[ {
  "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"
} ]
cURL request
$ curl 'http://localhost:8080/auth/permissions' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU5LCJleHAiOjE2MDEyODM4NTl9.NJpcdYWvEBgFxPrcmTFbVd1XlrChj5L4XgXn1ac0Q2Q'

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
Content-Length: 70
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU5LCJleHAiOjE2MDEyODM4NTl9.NJpcdYWvEBgFxPrcmTFbVd1XlrChj5L4XgXn1ac0Q2Q
Host: localhost:8080

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

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
Content-Length: 253
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

{
  "permissions" : [ {
    "name" : "account",
    "description" : "Full control of account settings",
    "category" : "Account"
  }, {
    "name" : "account:r",
    "description" : "Read access to account settings",
    "category" : "Account"
  } ]
}
cURL request
$ curl 'http://localhost:8080/auth/permissions/:check' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU5LCJleHAiOjE2MDEyODM4NTl9.NJpcdYWvEBgFxPrcmTFbVd1XlrChj5L4XgXn1ac0Q2Q' \
    -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
Host: localhost:8080
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU1LCJleHAiOjE2MDEyODM4NTV9.zUQqT_ZhdCEPW8Vb8O1AnlTF0tUY3cq88NkUgqK8kFw
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" : "2020-09-21T09:04:15.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU1LCJleHAiOjE2MDEyODM4NTV9.zUQqT_ZhdCEPW8Vb8O1AnlTF0tUY3cq88NkUgqK8kFw'

Get VIQ info

GET /account/viq
Request Fields
HTTP Request
GET /account/viq HTTP/1.1
Content-Type: application/json
Host: localhost:8080
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU1LCJleHAiOjE2MDEyODM4NTV9.zUQqT_ZhdCEPW8Vb8O1AnlTF0tUY3cq88NkUgqK8kFw
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" : "2020-09-21T09:04:15.000+0000",
    "update_time" : "2020-09-21T09:04:15.000+0000",
    "active_date" : "2020-09-21T09:04:15.000+0000",
    "expire_date" : "2021-09-21T09:04:15.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" : "2020-07-21T09:04:15.000+0000",
    "update_time" : "2020-07-21T09:04:15.000+0000",
    "active_date" : "2020-08-21T09:04:15.000+0000",
    "expire_date" : "2020-09-14T09:04:15.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU1LCJleHAiOjE2MDEyODM4NTV9.zUQqT_ZhdCEPW8Vb8O1AnlTF0tUY3cq88NkUgqK8kFw'

User

Get profile

GET /user/profile
HTTP Request
GET /user/profile HTTP/1.1
Content-Type: application/json
Host: localhost:8080
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU1LCJleHAiOjE2MDEyODM4NTV9.zUQqT_ZhdCEPW8Vb8O1AnlTF0tUY3cq88NkUgqK8kFw
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" : "2020-09-21T09:04:15.000+0000",
  "update_time" : "2020-09-21T09:04:15.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" : "2020-09-21T09:04:15.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 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU1LCJleHAiOjE2MDEyODM4NTV9.zUQqT_ZhdCEPW8Vb8O1AnlTF0tUY3cq88NkUgqK8kFw'

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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU5LCJleHAiOjE2MDEyODM4NTl9.NJpcdYWvEBgFxPrcmTFbVd1XlrChj5L4XgXn1ac0Q2Q
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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU5LCJleHAiOjE2MDEyODM4NTl9.NJpcdYWvEBgFxPrcmTFbVd1XlrChj5L4XgXn1ac0Q2Q'

Enable HIQ

POST /hiq/:enable
HTTP Request
POST /hiq/:enable HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU5LCJleHAiOjE2MDEyODM4NTl9.NJpcdYWvEBgFxPrcmTFbVd1XlrChj5L4XgXn1ac0Q2Q
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
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
cURL request
$ curl 'http://localhost:8080/hiq/:enable' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU5LCJleHAiOjE2MDEyODM4NTl9.NJpcdYWvEBgFxPrcmTFbVd1XlrChj5L4XgXn1ac0Q2Q'

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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDYwLCJleHAiOjE2MDEyODM4NjB9.5_nztBHNX4utIJr5xx9dWodivG4cwJ-czFxKaRZoA6Y
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: 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 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDYwLCJleHAiOjE2MDEyODM4NjB9.5_nztBHNX4utIJr5xx9dWodivG4cwJ-czFxKaRZoA6Y' \
    -H 'Content-Type: application/json'

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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDYwLCJleHAiOjE2MDEyODM4NjB9.5_nztBHNX4utIJr5xx9dWodivG4cwJ-czFxKaRZoA6Y
Content-Length: 62
Content-Type: application/json
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 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDYwLCJleHAiOjE2MDEyODM4NjB9.5_nztBHNX4utIJr5xx9dWodivG4cwJ-czFxKaRZoA6Y' \
    -H 'Content-Type: application/json' \
    -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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDYwLCJleHAiOjE2MDEyODM4NjB9.5_nztBHNX4utIJr5xx9dWodivG4cwJ-czFxKaRZoA6Y
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: 1

1
cURL request
$ curl 'http://localhost:8080/hiq/context/creating' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDYwLCJleHAiOjE2MDEyODM4NjB9.5_nztBHNX4utIJr5xx9dWodivG4cwJ-czFxKaRZoA6Y' \
    -H 'Content-Type: application/json'

Set creating context

Set organization for creating new data

PUT /hiq/context/creating
HTTP Request
PUT /hiq/context/creating HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDYwLCJleHAiOjE2MDEyODM4NjB9.5_nztBHNX4utIJr5xx9dWodivG4cwJ-czFxKaRZoA6Y
Content-Type: application/json
Content-Length: 1
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 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDYwLCJleHAiOjE2MDEyODM4NjB9.5_nztBHNX4utIJr5xx9dWodivG4cwJ-czFxKaRZoA6Y' \
    -H 'Content-Type: application/json' \
    -d '1'

Get reading context

Get organizations for reading data

GET /hiq/context/reading
HTTP Request
GET /hiq/context/reading HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDYwLCJleHAiOjE2MDEyODM4NjB9.5_nztBHNX4utIJr5xx9dWodivG4cwJ-czFxKaRZoA6Y
Content-Type: application/json
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 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDYwLCJleHAiOjE2MDEyODM4NjB9.5_nztBHNX4utIJr5xx9dWodivG4cwJ-czFxKaRZoA6Y' \
    -H 'Content-Type: application/json'

Set reading context

Set organizations for reading data

PUT /hhm/context/reading
HTTP Request
PUT /hiq/context/reading HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDYwLCJleHAiOjE2MDEyODM4NjB9.5_nztBHNX4utIJr5xx9dWodivG4cwJ-czFxKaRZoA6Y
Content-Length: 11
Content-Type: application/json
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 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDYwLCJleHAiOjE2MDEyODM4NjB9.5_nztBHNX4utIJr5xx9dWodivG4cwJ-czFxKaRZoA6Y' \
    -H 'Content-Type: application/json' \
    -d '[ 1, 2, 3 ]'

Create organization

POST /organizations
HTTP Request
POST /hiq/organizations HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU5LCJleHAiOjE2MDEyODM4NTl9.NJpcdYWvEBgFxPrcmTFbVd1XlrChj5L4XgXn1ac0Q2Q
Content-Length: 56
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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU5LCJleHAiOjE2MDEyODM4NTl9.NJpcdYWvEBgFxPrcmTFbVd1XlrChj5L4XgXn1ac0Q2Q' \
    -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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU5LCJleHAiOjE2MDEyODM4NTl9.NJpcdYWvEBgFxPrcmTFbVd1XlrChj5L4XgXn1ac0Q2Q
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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU5LCJleHAiOjE2MDEyODM4NTl9.NJpcdYWvEBgFxPrcmTFbVd1XlrChj5L4XgXn1ac0Q2Q'

Get all organizations

GET /organizations
HTTP Request
GET /hiq/organizations HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU5LCJleHAiOjE2MDEyODM4NTl9.NJpcdYWvEBgFxPrcmTFbVd1XlrChj5L4XgXn1ac0Q2Q
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" : "2020-09-21T09:04:19.000+0000",
  "update_time" : "2020-09-21T09:04:19.000+0000",
  "org_id" : 1
}, {
  "id" : 2,
  "name" : "Example-corp-1",
  "type" : "ORGANIZATION_TYPE_REGULAR",
  "color" : "red",
  "create_time" : "2020-09-21T09:04:19.000+0000",
  "update_time" : "2020-09-21T09:04:19.000+0000",
  "org_id" : 2
}, {
  "id" : 3,
  "name" : "Example-corp-2",
  "type" : "ORGANIZATION_TYPE_REGULAR",
  "color" : "red",
  "create_time" : "2020-09-21T09:04:19.000+0000",
  "update_time" : "2020-09-21T09:04:19.000+0000",
  "org_id" : 3
}, {
  "id" : 4,
  "name" : "Example-corp-3",
  "type" : "ORGANIZATION_TYPE_REGULAR",
  "color" : "red",
  "create_time" : "2020-09-21T09:04:19.000+0000",
  "update_time" : "2020-09-21T09:04:19.000+0000",
  "org_id" : 4
}, {
  "id" : 5,
  "name" : "Example-corp-4",
  "type" : "ORGANIZATION_TYPE_REGULAR",
  "color" : "red",
  "create_time" : "2020-09-21T09:04:19.000+0000",
  "update_time" : "2020-09-21T09:04:19.000+0000",
  "org_id" : 5
}, {
  "id" : 6,
  "name" : "Example-corp-5",
  "type" : "ORGANIZATION_TYPE_REGULAR",
  "color" : "red",
  "create_time" : "2020-09-21T09:04:19.000+0000",
  "update_time" : "2020-09-21T09:04:19.000+0000",
  "org_id" : 6
}, {
  "id" : 7,
  "name" : "Example-corp-6",
  "type" : "ORGANIZATION_TYPE_REGULAR",
  "color" : "red",
  "create_time" : "2020-09-21T09:04:19.000+0000",
  "update_time" : "2020-09-21T09:04:19.000+0000",
  "org_id" : 7
}, {
  "id" : 8,
  "name" : "Example-corp-7",
  "type" : "ORGANIZATION_TYPE_REGULAR",
  "color" : "red",
  "create_time" : "2020-09-21T09:04:19.000+0000",
  "update_time" : "2020-09-21T09:04:19.000+0000",
  "org_id" : 8
}, {
  "id" : 9,
  "name" : "Example-corp-8",
  "type" : "ORGANIZATION_TYPE_REGULAR",
  "color" : "red",
  "create_time" : "2020-09-21T09:04:19.000+0000",
  "update_time" : "2020-09-21T09:04:19.000+0000",
  "org_id" : 9
}, {
  "id" : 10,
  "name" : "Example-corp-9",
  "type" : "ORGANIZATION_TYPE_REGULAR",
  "color" : "red",
  "create_time" : "2020-09-21T09:04:19.000+0000",
  "update_time" : "2020-09-21T09:04:19.000+0000",
  "org_id" : 10
} ]
cURL request
$ curl 'http://localhost:8080/hiq/organizations' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU5LCJleHAiOjE2MDEyODM4NTl9.NJpcdYWvEBgFxPrcmTFbVd1XlrChj5L4XgXn1ac0Q2Q'

Rename organization

POST /organizations/{id}/:rename
HTTP Request
POST /hiq/organizations/1/:rename HTTP/1.1
Content-Length: 21
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU5LCJleHAiOjE2MDEyODM4NTl9.NJpcdYWvEBgFxPrcmTFbVd1XlrChj5L4XgXn1ac0Q2Q
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 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU5LCJleHAiOjE2MDEyODM4NTl9.NJpcdYWvEBgFxPrcmTFbVd1XlrChj5L4XgXn1ac0Q2Q' \
    -d 'New organization name'

Device

Get device list

GET /devices
Request Pamameters
Parameter Description

page

Page number

limit

Page size

HTTP Request
GET /devices?page=1&limit=10 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU5LCJleHAiOjE2MDEyODM4NTl9.NJpcdYWvEBgFxPrcmTFbVd1XlrChj5L4XgXn1ac0Q2Q
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.

HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
Content-Length: 5161
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" : 1,
    "hostname" : "PLAN-6216E1-0",
    "connected" : true,
    "create_time" : "2020-09-21T09:04:19.000+0000",
    "update_time" : "2020-09-21T09:04:19.000+0000",
    "org_id" : 10,
    "serial_number" : "08623254987562",
    "service_tag" : "",
    "mac_address" : "twbcLNizgiYb",
    "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"
  }, {
    "id" : 2,
    "hostname" : "PLAN-6216E1-1",
    "connected" : true,
    "create_time" : "2020-09-21T09:04:19.000+0000",
    "update_time" : "2020-09-21T09:04:19.000+0000",
    "org_id" : 10,
    "serial_number" : "30870004322674",
    "service_tag" : "",
    "mac_address" : "hU7E7upMpL2n",
    "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"
  }, {
    "id" : 3,
    "hostname" : "PLAN-6216E1-2",
    "connected" : true,
    "create_time" : "2020-09-21T09:04:19.000+0000",
    "update_time" : "2020-09-21T09:04:19.000+0000",
    "org_id" : 10,
    "serial_number" : "76531576499967",
    "service_tag" : "",
    "mac_address" : "YRmkVKmItVMm",
    "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"
  }, {
    "id" : 4,
    "hostname" : "PLAN-6216E1-3",
    "connected" : true,
    "create_time" : "2020-09-21T09:04:19.000+0000",
    "update_time" : "2020-09-21T09:04:19.000+0000",
    "org_id" : 10,
    "serial_number" : "02349600120355",
    "service_tag" : "",
    "mac_address" : "X14zdFbgLqjD",
    "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"
  }, {
    "id" : 5,
    "hostname" : "PLAN-6216E1-4",
    "connected" : true,
    "create_time" : "2020-09-21T09:04:19.000+0000",
    "update_time" : "2020-09-21T09:04:19.000+0000",
    "org_id" : 10,
    "serial_number" : "00677318806136",
    "service_tag" : "",
    "mac_address" : "FDhKCNleCTF2",
    "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"
  }, {
    "id" : 6,
    "hostname" : "PLAN-6216E1-5",
    "connected" : true,
    "create_time" : "2020-09-21T09:04:19.000+0000",
    "update_time" : "2020-09-21T09:04:19.000+0000",
    "org_id" : 10,
    "serial_number" : "73929999580440",
    "service_tag" : "",
    "mac_address" : "IzBVt6RflVCG",
    "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"
  }, {
    "id" : 7,
    "hostname" : "PLAN-6216E1-6",
    "connected" : true,
    "create_time" : "2020-09-21T09:04:19.000+0000",
    "update_time" : "2020-09-21T09:04:19.000+0000",
    "org_id" : 10,
    "serial_number" : "79783981026571",
    "service_tag" : "",
    "mac_address" : "ktGgYX5cUnsQ",
    "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"
  }, {
    "id" : 8,
    "hostname" : "PLAN-6216E1-7",
    "connected" : true,
    "create_time" : "2020-09-21T09:04:19.000+0000",
    "update_time" : "2020-09-21T09:04:19.000+0000",
    "org_id" : 10,
    "serial_number" : "67370503500114",
    "service_tag" : "",
    "mac_address" : "9tgbcLyc7DLt",
    "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"
  }, {
    "id" : 9,
    "hostname" : "PLAN-6216E1-8",
    "connected" : true,
    "create_time" : "2020-09-21T09:04:19.000+0000",
    "update_time" : "2020-09-21T09:04:19.000+0000",
    "org_id" : 10,
    "serial_number" : "14556464798245",
    "service_tag" : "",
    "mac_address" : "UdlKeO3e1y6Y",
    "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"
  }, {
    "id" : 10,
    "hostname" : "PLAN-6216E1-9",
    "connected" : true,
    "create_time" : "2020-09-21T09:04:19.000+0000",
    "update_time" : "2020-09-21T09:04:19.000+0000",
    "org_id" : 10,
    "serial_number" : "88248127164319",
    "service_tag" : "",
    "mac_address" : "oi919679A4ki",
    "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"
  } ],
  "total_pages" : 2,
  "total_count" : 15
}
cURL request
$ curl 'http://localhost:8080/devices?page=1&limit=10' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU5LCJleHAiOjE2MDEyODM4NTl9.NJpcdYWvEBgFxPrcmTFbVd1XlrChj5L4XgXn1ac0Q2Q'

Get device details

GET /devices/{id}
HTTP Request
GET /devices/1 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU4LCJleHAiOjE2MDEyODM4NTh9.fYKAWQ0ZFCUDIKlaDr7v5xJhzsTW0k3RhIawdy9MAvM
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: 475

{
  "id" : 1,
  "hostname" : "PLAN-6216E1-1",
  "connected" : true,
  "create_time" : "2020-09-21T09:04:18.000+0000",
  "update_time" : "2020-09-21T09:04:18.000+0000",
  "org_id" : 10,
  "serial_number" : "72522424288969",
  "service_tag" : "",
  "mac_address" : "4xLBSOsiEjGO",
  "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"
}
cURL request
$ curl 'http://localhost:8080/devices/1' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU4LCJleHAiOjE2MDEyODM4NTh9.fYKAWQ0ZFCUDIKlaDr7v5xJhzsTW0k3RhIawdy9MAvM'

Onboard devices

POST /devices
HTTP Request
POST /devices HTTP/1.1
Content-Length: 309
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU5LCJleHAiOjE2MDEyODM4NTl9.NJpcdYWvEBgFxPrcmTFbVd1XlrChj5L4XgXn1ac0Q2Q
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 Response
HTTP/1.1 201 Created
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' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU5LCJleHAiOjE2MDEyODM4NTl9.NJpcdYWvEBgFxPrcmTFbVd1XlrChj5L4XgXn1ac0Q2Q' \
    -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.

DELETE /devices
HTTP Request
DELETE /devices HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU5LCJleHAiOjE2MDEyODM4NTl9.NJpcdYWvEBgFxPrcmTFbVd1XlrChj5L4XgXn1ac0Q2Q
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
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
cURL request
$ curl 'http://localhost:8080/devices' -i -X DELETE \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU5LCJleHAiOjE2MDEyODM4NTl9.NJpcdYWvEBgFxPrcmTFbVd1XlrChj5L4XgXn1ac0Q2Q'

Reboot devices

POST /devices/:reboot
HTTP Request
POST /devices/:reboot HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU5LCJleHAiOjE2MDEyODM4NTl9.NJpcdYWvEBgFxPrcmTFbVd1XlrChj5L4XgXn1ac0Q2Q
Host: localhost:8080
Content-Length: 25

{
  "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 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU5LCJleHAiOjE2MDEyODM4NTl9.NJpcdYWvEBgFxPrcmTFbVd1XlrChj5L4XgXn1ac0Q2Q' \
    -d '{
  "ids" : [ 1, 2, 3 ]
}'

Send CLI

Send CLI to devices.

POST /devices/:cli
HTTP Request
POST /devices/:cli HTTP/1.1
Content-Length: 94
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU4LCJleHAiOjE2MDEyODM4NTh9.fYKAWQ0ZFCUDIKlaDr7v5xJhzsTW0k3RhIawdy9MAvM
Host: localhost:8080

{
  "filter" : {
    "ids" : [ 1, 2, 3 ]
  },
  "clis" : [ "CLI_to_send_1", "CLI_to_send2" ]
}
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: 38
Content-Type: application/json;charset=UTF-8
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "device ID -> CLI outputs" : { }
}
cURL request
$ curl 'http://localhost:8080/devices/:cli' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU4LCJleHAiOjE2MDEyODM4NTh9.fYKAWQ0ZFCUDIKlaDr7v5xJhzsTW0k3RhIawdy9MAvM' \
    -d '{
  "filter" : {
    "ids" : [ 1, 2, 3 ]
  },
  "clis" : [ "CLI_to_send_1", "CLI_to_send2" ]
}'

Push configuration

Push configuration to devices.

POST /devices/:deploy
HTTP Request
POST /devices/:deploy HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU4LCJleHAiOjE2MDEyODM4NTh9.fYKAWQ0ZFCUDIKlaDr7v5xJhzsTW0k3RhIawdy9MAvM
Host: localhost:8080
Content-Length: 25

{
  "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/:deploy' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU4LCJleHAiOjE2MDEyODM4NTh9.fYKAWQ0ZFCUDIKlaDr7v5xJhzsTW0k3RhIawdy9MAvM' \
    -d '{
  "ids" : [ 1, 2, 3 ]
}'

Change status to Managed

Change device management status to Managed status.

POST /devices/:manage
Request Fields
{
  "ids" : [ 1, 2, 3 ]
}
HTTP Request
POST /devices/:manage HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU4LCJleHAiOjE2MDEyODM4NTh9.fYKAWQ0ZFCUDIKlaDr7v5xJhzsTW0k3RhIawdy9MAvM
Host: localhost:8080
Content-Length: 25

{
  "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/:manage' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU4LCJleHAiOjE2MDEyODM4NTh9.fYKAWQ0ZFCUDIKlaDr7v5xJhzsTW0k3RhIawdy9MAvM' \
    -d '{
  "ids" : [ 1, 2, 3 ]
}'

Change status to Unmanaged

Change device management status to Unmanaged status.

POST /devices/:unmanage
HTTP Request
POST /devices/:unmanage HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU4LCJleHAiOjE2MDEyODM4NTh9.fYKAWQ0ZFCUDIKlaDr7v5xJhzsTW0k3RhIawdy9MAvM
Host: localhost:8080
Content-Length: 25

{
  "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 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU4LCJleHAiOjE2MDEyODM4NTh9.fYKAWQ0ZFCUDIKlaDr7v5xJhzsTW0k3RhIawdy9MAvM' \
    -d '{
  "ids" : [ 1, 2, 3 ]
}'

Client

Get client list

GET /clients
HTTP Request
GET /clients/active HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU5LCJleHAiOjE2MDEyODM4NTl9.NJpcdYWvEBgFxPrcmTFbVd1XlrChj5L4XgXn1ac0Q2Q
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: 815
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,
    "create_time" : "2020-09-21T09:04:19.000+0000",
    "update_time" : "2020-09-21T09:04:19.000+0000",
    "org_id" : null
  }, {
    "id" : 2,
    "create_time" : "2020-09-21T09:04:19.000+0000",
    "update_time" : "2020-09-21T09:04:19.000+0000",
    "org_id" : null
  }, {
    "id" : 4,
    "create_time" : "2020-09-21T09:04:19.000+0000",
    "update_time" : "2020-09-21T09:04:19.000+0000",
    "org_id" : null
  }, {
    "id" : 6,
    "create_time" : "2020-09-21T09:04:19.000+0000",
    "update_time" : "2020-09-21T09:04:19.000+0000",
    "org_id" : null
  }, {
    "id" : 8,
    "create_time" : "2020-09-21T09:04:19.000+0000",
    "update_time" : "2020-09-21T09:04:19.000+0000",
    "org_id" : null
  } ],
  "total_pages" : 2,
  "total_count" : 15
}
cURL request
$ curl 'http://localhost:8080/clients/active' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJJZCI6MSwicm9sZSI6IkFkbWluaXN0cmF0b3IiLCJvd25lcklkIjoxMDIsImRhdGFDZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwiYWNjb3VudCIsImFjY291bnQ6ciIsInVzZXIiLCJ1c2VyOnIiLCJoaXEiLCJoaXE6ciIsImhpcTplbmFibGUiLCJvcmciLCJvcmc6bmV3Iiwib3JnOmRlbCIsIm9yZzpyZW5hbWUiLCJoaXEuY3R4IiwiaGlxLmN0eDpyIiwiaGlxLmN0eDp3IiwiZGV2aWNlIiwiZGV2aWNlOnIiLCJkZXZpY2U6bGlzdCIsImRldmljZTp2aWV3IiwiZGV2aWNlOm5ldyIsImRldmljZTpkZWwiLCJkZXZpY2U6Y2xpIiwiZGV2aWNlOmRlcGxveSIsImRldmljZTptYW5hZ2UiLCJkZXZpY2U6dW5tYW5hZ2UiLCJkZXZpY2U6cmVib290IiwiY2xpZW50IiwiY2xpZW50OnIiXSwiaXNzIjoiZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNjAwNjc5MDU5LCJleHAiOjE2MDEyODM4NTl9.NJpcdYWvEBgFxPrcmTFbVd1XlrChj5L4XgXn1ac0Q2Q'

Get client details

GET /clients/{id}

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