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

Please access ExtremeCloud IQ Developer portal to get more examples and tutorials.

Authentication

Login

POST /login

Request Fields

Path Type Description

username

String

The login username

password

String

The login password

HTTP Request

POST /login HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Content-Length: 67

{
  "password" : "belDbNWjF9",
  "username" : "admin@company.com"
}

cURL Request

$ curl 'https://api.extremecloudiq.com/login' -i -X POST \
    -H 'Content-Type: application/json' \
    -d '{
  "password" : "belDbNWjF9",
  "username" : "admin@company.com"
}'

Response Fields

Path Type Description

access_token

String

The access token with JWT format issued by ExtremeCloud IQ

token_type

String

The type of token, only supports "Bearer" currently

expires_in

Number

The lifetime in seconds of the access token

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-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Content-Length: 2788

{
  "access_token" : "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzMSwiZXhwIjoxNzE5MjU1NjMxfQ.ej9a9ZoeOfnIzf-2e0wKqJSQMpeDEuh22CPa0cQb_58",
  "token_type" : "Bearer",
  "expires_in" : 604800
}

Unsuccessful Login Response

HTTP/1.1 400 Bad Request
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Content-Length: 125

{
  "error_code" : "BAD_REQUEST",
  "error_id" : "9987483bb36e4f4aaf1360057564fc35",
  "error_message" : "Access Denied!!!"
}

Logout

POST /logout

Request Fields

No request field required, please make sure Bearer token is included in HTTP Authorization header, which will be revoked when calling this endpoint.

HTTP Request

POST /logout HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzMSwiZXhwIjoxNzE5MjU1NjMxfQ.ej9a9ZoeOfnIzf-2e0wKqJSQMpeDEuh22CPa0cQb_58
Host: api.extremecloudiq.com
Content-Type: application/json

cURL Request

$ curl 'https://api.extremecloudiq.com/logout' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzMSwiZXhwIjoxNzE5MjU1NjMxfQ.ej9a9ZoeOfnIzf-2e0wKqJSQMpeDEuh22CPa0cQb_58' \
    -H 'Content-Type: application/json'

Response Fields

No response field will be returned.

Successful Logout Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
RateLimit-Remaining: 7280
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

Unsuccessful Logout Response

If the access token was revoked, the logout will be failed.

HTTP/1.1 401 Unauthorized
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
Content-Length: 92
X-Content-Type-Options: nosniff
Content-Type: application/json
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "error_code" : "AUTH_TOKEN_REVOKED",
  "error_id" : "2fb7be3ecf524744a5c3a1ff62956c92"
}

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
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzOCwiZXhwIjoxNzE5MjU1NjM4fQ.DV2k0G8a_LjEONKt7EQPBPD6IkdNRGwgwY-B4ZXIZ_Y
Content-Type: application/json
Content-Length: 118

{
  "expire_time" : 1718654438,
  "description" : "API Token for account read.",
  "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
RateLimit-Remaining: 7264
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Content-Length: 565

{
  "access_token" : "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInNjb3BlcyI6WyJyZWFkOmFjY291bnQiXSwidXNlcklkIjoxLCJyb2xlIjoiQWRtaW5pc3RyYXRvciIsIm93bmVySWQiOjEwMiwiZGF0YUNlbnRlciI6IlVTX1dlc3QiLCJpc3MiOiJleHRyZW1lY2xvdWRpcS5jb20iLCJpYXQiOjE1OTgzNTg3NDYsImV4cCI6MTU5ODM2MjM0Nn0.aP5lD3i8TfmGSWeGacXmJfhne9rSI_06iaGOzdzMj4k",
  "create_time" : "2024-06-17T19:00:38.000+0000",
  "expire_time" : "2024-06-17T20:00:38.000+0000",
  "creator_id" : 1,
  "customer_id" : 1,
  "description" : "API Token for account read.",
  "permissions" : [ "read:account" ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/auth/apitoken' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzOCwiZXhwIjoxNzE5MjU1NjM4fQ.DV2k0G8a_LjEONKt7EQPBPD6IkdNRGwgwY-B4ZXIZ_Y' \
    -H 'Content-Type: application/json' \
    -d '{
  "expire_time" : 1718654438,
  "description" : "API Token for account read.",
  "permissions" : [ "write*:auth" ]
}'

Get API token details

GET /auth/apitoken/info

HTTP Request

GET /auth/apitoken/info HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzOCwiZXhwIjoxNzE5MjU1NjM4fQ.DV2k0G8a_LjEONKt7EQPBPD6IkdNRGwgwY-B4ZXIZ_Y
Content-Type: application/json

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
RateLimit-Remaining: 7265
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Length: 2103
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "user_name" : "admin@cust001.com",
  "user_id" : 1,
  "role" : "Administrator",
  "owner_id" : 102,
  "data_center" : "US_WEST",
  "scopes" : [ "logout", "auth", "auth:r", "token:new", "perm:check", "lro", "lro:r", "account", "account:switch", "account:r", "viq:backup", "user", "user-me:r", "user:r", "hiq", "hiq:r", "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", "device:reset", "device:thread-commissioner", "client", "client:r", "locations", "locations:r", "network-policy", "policy:ssid", "network-policy:r", "network-scorecard", "network-scorecard:r", "ssid", "ssid:r", "pcg:key", "pcg:key:r", "subscriptions-webhook", "subscriptions-webhook:r", "ccg", "ccg:r", "log", "log:r", "cwp", "cwp:r", "sms-tmpl", "sms-tmpl:r", "class-rule", "class-rule:r", "user-profile", "user-profile:r", "radius-proxy", "radius-proxy:r", "radius-server", "radius-server:r", "usergroup", "usergroup:r", "deployment", "deployment:r", "ad-server", "ad-server:r", "alert", "alert:r", "alert-policies", "alert-policies:r", "alert-subscriptions", "alert-subscriptions:r", "app", "application:r", "l3-address-profile", "l3-address-profile:r", "vlan-profile", "vlan-profile:r", "enduser", "enduser:r", "radius-client-object", "radius-client-object:r", "ldap-server", "ldap-server:r", "email-template", "email-template:r", "certificate", "certificate:r", "radio-profile", "radio-profile:r", "iot-profile", "iot-profile:r", "client-monitor-profile", "client-monitor-profile:r", "copilot-connectivity-wired:r", "copilot-connectivity-wireless:r", "copilot-anomalies:r", "licenses", "licenses:r", "copilot-assurance-scans:r", "packet-capture", "packet-capture:r", "country", "country:r", "cas", "cas:r", "cas-policies", "cas-policies:r", "cas-metadata:r", "cns-subscriptions", "cns-subscriptions:r" ],
  "issued_at" : "2024-06-17T19:00:38.000+0000",
  "expiration_time" : "2024-06-24T19:00:38.000+0000",
  "expires_in" : 604799
}

cURL Request

$ curl 'https://api.extremecloudiq.com/auth/apitoken/info' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzOCwiZXhwIjoxNzE5MjU1NjM4fQ.DV2k0G8a_LjEONKt7EQPBPD6IkdNRGwgwY-B4ZXIZ_Y' \
    -H 'Content-Type: application/json'

Validate API token

POST /auth/apitoken/:validate

Request Body

eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzOCwiZXhwIjoxNzE5MjU1NjM4fQ.DV2k0G8a_LjEONKt7EQPBPD6IkdNRGwgwY-B4ZXIZ_Y

HTTP Request

POST /auth/apitoken/:validate HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: text/plain
Content-Length: 2711

eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzOCwiZXhwIjoxNzE5MjU1NjM4fQ.DV2k0G8a_LjEONKt7EQPBPD6IkdNRGwgwY-B4ZXIZ_Y

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

cURL Request

$ curl 'https://api.extremecloudiq.com/auth/apitoken/:validate' -i -X POST \
    -H 'Content-Type: text/plain' \
    -d 'eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzOCwiZXhwIjoxNzE5MjU1NjM4fQ.DV2k0G8a_LjEONKt7EQPBPD6IkdNRGwgwY-B4ZXIZ_Y'

Get user permissions

GET /auth/permissions

HTTP Request

GET /auth/permissions HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzNSwiZXhwIjoxNzE5MjU1NjM1fQ.H4umj8bCWXVoqduKb0oWm8c4YMbEs2UfaRgLpUyqSCU

Response Fields

Path Type Description

[].name

String

The permission name

[].description

String

The description for the permission

[].category

String

The category for the permission

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Length: 13595
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
RateLimit-Remaining: 7260
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

[ {
  "name" : "logout",
  "description" : "Logout",
  "category" : "Authentication"
}, {
  "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" : "lro",
  "description" : "Full control of long-running operations",
  "category" : "Operation"
}, {
  "name" : "lro:r",
  "description" : "Read access of long-running operations",
  "category" : "Operation"
}, {
  "name" : "account",
  "description" : "Full control of account settings",
  "category" : "Account"
}, {
  "name" : "account:switch",
  "description" : "Switch to another ExtremeCloud IQ account",
  "category" : "Account"
}, {
  "name" : "account:r",
  "description" : "Read access to account settings",
  "category" : "Account"
}, {
  "name" : "viq:backup",
  "description" : "Backup VIQ",
  "category" : "Account"
}, {
  "name" : "user",
  "description" : "Full control of users",
  "category" : "User"
}, {
  "name" : "user-me:r",
  "description" : "Read access to user self",
  "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" : "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 devices",
  "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" : "device:reset",
  "description" : "Reset the device to factory default",
  "category" : "Device"
}, {
  "name" : "device:thread-commissioner",
  "description" : "Start or Stop Thread Commissioner",
  "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" : "policy:ssid",
  "description" : "SSID management on network-policy",
  "category" : "Network Policy"
}, {
  "name" : "network-policy:r",
  "description" : "Read access to network-policy",
  "category" : "Network Policy"
}, {
  "name" : "network-scorecard",
  "description" : "Full control of network-scorecard",
  "category" : "Network Scorecard"
}, {
  "name" : "network-scorecard:r",
  "description" : "Read access to network-scorecard",
  "category" : "Network Scorecard"
}, {
  "name" : "ssid",
  "description" : "Full control of SSID",
  "category" : "SSID"
}, {
  "name" : "ssid:r",
  "description" : "Read access to SSID",
  "category" : "SSID"
}, {
  "name" : "pcg:key",
  "description" : "Full control of PCG key based",
  "category" : "Configuration - User Management"
}, {
  "name" : "pcg:key:r",
  "description" : "Read access to PCG key based",
  "category" : "Configuration - User Management"
}, {
  "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" : "log",
  "description" : "Full control of logs",
  "category" : "LOGS"
}, {
  "name" : "log:r",
  "description" : "Read access to logs",
  "category" : "LOGS"
}, {
  "name" : "cwp",
  "description" : "Full control of captive web portals",
  "category" : "Configuration - Authentication"
}, {
  "name" : "cwp:r",
  "description" : "Read access to captive web portals",
  "category" : "Configuration - Authentication"
}, {
  "name" : "sms-tmpl",
  "description" : "Full control of SMS template",
  "category" : "Configuration - User Management"
}, {
  "name" : "sms-tmpl:r",
  "description" : "Read access to SMS template",
  "category" : "Configuration - User Management"
}, {
  "name" : "class-rule",
  "description" : "Full control of classification rule",
  "category" : "Configuration - Policy"
}, {
  "name" : "class-rule:r",
  "description" : "Read access to classification rule",
  "category" : "Configuration - Policy"
}, {
  "name" : "user-profile",
  "description" : "Full control of user profile",
  "category" : "Configuration - Policy"
}, {
  "name" : "user-profile:r",
  "description" : "Read access to user profile",
  "category" : "Configuration - Policy"
}, {
  "name" : "radius-proxy",
  "description" : "Full control of radius proxy",
  "category" : "Configuration - Authentication"
}, {
  "name" : "radius-proxy:r",
  "description" : "Read access to radius proxy",
  "category" : "Configuration - Authentication"
}, {
  "name" : "radius-server",
  "description" : "Full control of RADIUS server",
  "category" : "Configuration - Authentication"
}, {
  "name" : "radius-server:r",
  "description" : "Read access to RADIUS server",
  "category" : "Configuration - Authentication"
}, {
  "name" : "usergroup",
  "description" : "Full control of user group",
  "category" : "Configuration - User Management"
}, {
  "name" : "usergroup:r",
  "description" : "Read access to usergroup",
  "category" : "Configuration - User Management"
}, {
  "name" : "deployment",
  "description" : "Full control of deployment",
  "category" : "Configuration - Deployment"
}, {
  "name" : "deployment:r",
  "description" : "Read access to deployment",
  "category" : "Configuration - Deployment"
}, {
  "name" : "ad-server",
  "description" : "Full control of AD server",
  "category" : "Configuration - Authentication"
}, {
  "name" : "ad-server:r",
  "description" : "Read access to AD server",
  "category" : "Configuration - Authentication"
}, {
  "name" : "alert",
  "description" : "Full control of alert",
  "category" : "Alert"
}, {
  "name" : "alert:r",
  "description" : "Read access to alert",
  "category" : "Alert"
}, {
  "name" : "alert-policies",
  "description" : "Full control of alert policy",
  "category" : "alert-policies"
}, {
  "name" : "alert-policies:r",
  "description" : "Read access to alert policy",
  "category" : "alert-policies"
}, {
  "name" : "alert-subscriptions",
  "description" : "Full control of alert subscription",
  "category" : "alert-subscriptions"
}, {
  "name" : "alert-subscriptions:r",
  "description" : "Read access to alert subscription",
  "category" : "alert-subscriptions"
}, {
  "name" : "app",
  "description" : "Full control of application",
  "category" : "Application"
}, {
  "name" : "application:r",
  "description" : "Read access to application",
  "category" : "Application"
}, {
  "name" : "l3-address-profile",
  "description" : "Full control of L3 address profile",
  "category" : "Configuration - Policy"
}, {
  "name" : "l3-address-profile:r",
  "description" : "Read access to L3 address profile",
  "category" : "Configuration - Policy"
}, {
  "name" : "vlan-profile",
  "description" : "Full control of VLAN profile",
  "category" : "Configuration - Basic"
}, {
  "name" : "vlan-profile:r",
  "description" : "Read access to VLAN profile",
  "category" : "Configuration - Basic"
}, {
  "name" : "enduser",
  "description" : "Full control of end users",
  "category" : "Configuration - User Management"
}, {
  "name" : "enduser:r",
  "description" : "Read access to end users",
  "category" : "Configuration - User Management"
}, {
  "name" : "radius-client-object",
  "description" : "Full control of RADIUS client object",
  "category" : "Configuration - Authentication"
}, {
  "name" : "radius-client-object:r",
  "description" : "Read access to RADIUS client object",
  "category" : "Configuration - Authentication"
}, {
  "name" : "ldap-server",
  "description" : "Full control of LDAP server",
  "category" : "Configuration - Authentication"
}, {
  "name" : "ldap-server:r",
  "description" : "Read access to LDAP server",
  "category" : "Configuration - Authentication"
}, {
  "name" : "email-template",
  "description" : "Full control of email template",
  "category" : "Configuration - User Management"
}, {
  "name" : "email-template:r",
  "description" : "Read access to email template",
  "category" : "Configuration - User Management"
}, {
  "name" : "certificate",
  "description" : "Full control of certificate",
  "category" : "Configuration - Certificate"
}, {
  "name" : "certificate:r",
  "description" : "Read access to certificate",
  "category" : "Configuration - Certificate"
}, {
  "name" : "radio-profile",
  "description" : "Full control of Radio Profile",
  "category" : "Configuration - Policy"
}, {
  "name" : "radio-profile:r",
  "description" : "Read access to Radio Profile",
  "category" : "Configuration - Policy"
}, {
  "name" : "iot-profile",
  "description" : "Full control of IoT Profile",
  "category" : "Configuration - Policy"
}, {
  "name" : "iot-profile:r",
  "description" : "Read access to IoT Profile",
  "category" : "Configuration - Policy"
}, {
  "name" : "client-monitor-profile",
  "description" : "Full control of Client Monitor Profile",
  "category" : "Configuration - Policy"
}, {
  "name" : "client-monitor-profile:r",
  "description" : "Read access to Client Monitor Profile",
  "category" : "Configuration - Policy"
}, {
  "name" : "copilot-connectivity-wired:r",
  "description" : "Read access to Copilot Connectivity wired",
  "category" : "Copilot - Connectivity Experience"
}, {
  "name" : "copilot-connectivity-wireless:r",
  "description" : "Read access to Copilot Connectivity wireless",
  "category" : "Copilot - Connectivity Experience"
}, {
  "name" : "copilot-anomalies:r",
  "description" : "Read access to Copilot Anomalies",
  "category" : "Copilot - Anomalies"
}, {
  "name" : "licenses",
  "description" : "Full control of licenses",
  "category" : "License"
}, {
  "name" : "licenses:r",
  "description" : "Read access to licenses",
  "category" : "Licence"
}, {
  "name" : "copilot-assurance-scans:r",
  "description" : "Read access to Copilot Assurance scan",
  "category" : "Copilot - Anomalies"
}, {
  "name" : "packet-capture",
  "description" : "Full control of packet captures",
  "category" : "Client"
}, {
  "name" : "packet-capture:r",
  "description" : "Read access to packet captures",
  "category" : "Client"
}, {
  "name" : "country",
  "description" : "Full control of country list and country codes",
  "category" : "Misc - Metadata Country"
}, {
  "name" : "country:r",
  "description" : "Read access to country list and country codes",
  "category" : "Misc - Metadata Country"
}, {
  "name" : "cas",
  "description" : "Full control of alert",
  "category" : "cas"
}, {
  "name" : "cas:r",
  "description" : "Read access to alert",
  "category" : "cas"
}, {
  "name" : "cas-policies",
  "description" : "Full control of alert policy",
  "category" : "cas-policies"
}, {
  "name" : "cas-policies:r",
  "description" : "Read access to alert policy",
  "category" : "cas-policies"
}, {
  "name" : "cas-metadata:r",
  "description" : "Read access to alert metadata",
  "category" : "cas-metadata"
}, {
  "name" : "cns-subscriptions",
  "description" : "Full control of alert subscription",
  "category" : "cns-subscriptions"
}, {
  "name" : "cns-subscriptions:r",
  "description" : "Read access to alert subscription",
  "category" : "cns-subscriptions"
} ]

cURL Request

$ curl 'https://api.extremecloudiq.com/auth/permissions' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzNSwiZXhwIjoxNzE5MjU1NjM1fQ.H4umj8bCWXVoqduKb0oWm8c4YMbEs2UfaRgLpUyqSCU'

Check permissions

POST /auth/permissions/:check

Request Fields

Path Type Description

uri

String

The request URI.

method

String

The HTTP request method.

HTTP Request

POST /auth/permissions/:check HTTP/1.1
Host: api.extremecloudiq.com
Content-Length: 70
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzNSwiZXhwIjoxNzE5MjU1NjM1fQ.H4umj8bCWXVoqduKb0oWm8c4YMbEs2UfaRgLpUyqSCU

{
  "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
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
RateLimit-Remaining: 7260
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 'https://api.extremecloudiq.com/auth/permissions/:check' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzNSwiZXhwIjoxNzE5MjU1NjM1fQ.H4umj8bCWXVoqduKb0oWm8c4YMbEs2UfaRgLpUyqSCU' \
    -d '{
  "uri" : "http://localhost:8081/account/info",
  "method" : "get"
}'

Account

Switch account

POST /account/:switch

Request Parameters

Parameter Description

id

The ExtremeCloud IQ account ID to switch, 0 means switch back to home XIQ account.

HTTP Request

POST /account/:switch HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc5MiwiZXhwIjoxNzE5MjU1NTkyfQ.Qp4J5dblyhPby9bu_tGndvLscLU41YI0OZqq7dKSHjU
Content-Type: application/json

id=1

Response Fields

Path Type Description

access_token

String

Access token for the new account.

token_type

String

The type of token, only supports "Bearer" currently

expires_in

Number

The lifetime in seconds of the access token

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
RateLimit-Remaining: 7346
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Content-Length: 2788

{
  "access_token" : "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc5MiwiZXhwIjoxNzE5MjU1NTkyfQ.Qp4J5dblyhPby9bu_tGndvLscLU41YI0OZqq7dKSHjU",
  "token_type" : "Bearer",
  "expires_in" : 604800
}

cURL Request

$ curl 'https://api.extremecloudiq.com/account/:switch' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc5MiwiZXhwIjoxNzE5MjU1NTkyfQ.Qp4J5dblyhPby9bu_tGndvLscLU41YI0OZqq7dKSHjU' \
    -H 'Content-Type: application/json' \
    -d 'id=1'

List external accounts

GET /account/external

HTTP Request

GET /account/external HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc5MSwiZXhwIjoxNzE5MjU1NTkxfQ.dRJdmJxf8RchfY6xsBtoMhxxTy5VZFKCN4i-gBZv_JQ
Content-Type: application/json

Response Fields

Path Type Description

[].id

Number

The external account ID.

[].name

String

The external account name.

[].create_time

String

The create time.

[].update_time

String

The last update time.

[].data_center

String

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

[].alias

String

The alias of the external account.

[].active

Boolean

Flag to indicate whether external account is active.

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
RateLimit-Remaining: 7347
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Content-Length: 433

[ {
  "id" : 1,
  "create_time" : "2024-06-17T18:59:52.000+0000",
  "update_time" : "2024-06-17T18:59:52.000+0000",
  "name" : "admin1@cust001.com",
  "alias" : "admin1",
  "active" : false,
  "data_center" : "VA2"
}, {
  "id" : 2,
  "create_time" : "2024-06-17T18:59:52.000+0000",
  "update_time" : "2024-06-17T18:59:52.000+0000",
  "name" : "admin2@cust001.com",
  "alias" : "admin2",
  "active" : true,
  "data_center" : "VA2"
} ]

cURL Request

$ curl 'https://api.extremecloudiq.com/account/external' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc5MSwiZXhwIjoxNzE5MjU1NTkxfQ.dRJdmJxf8RchfY6xsBtoMhxxTy5VZFKCN4i-gBZv_JQ' \
    -H 'Content-Type: application/json'

Get basic info

GET /account/home

HTTP Request

GET /account/home HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc5MSwiZXhwIjoxNzE5MjU1NTkxfQ.dRJdmJxf8RchfY6xsBtoMhxxTy5VZFKCN4i-gBZv_JQ
Content-Type: application/json

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.

quota

String

The max API requests per minute.

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
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
Content-Length: 405
X-Content-Type-Options: nosniff
RateLimit-Remaining: 7349
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "id" : 1,
  "create_time" : "2024-06-17T18:59:51.000+0000",
  "update_time" : "1970-01-01T00:00:00.000+0000",
  "name" : "admin@cust001.com",
  "account_type" : "CUSTOMER",
  "account_mode" : "CONNECT",
  "quota" : "7500;w=3600",
  "data_center" : "VA2",
  "industry" : "test industry",
  "country" : "US",
  "state" : "",
  "city" : "aaa",
  "address" : "test address",
  "zipcode" : "test zipcode"
}

cURL Request

$ curl 'https://api.extremecloudiq.com/account/home' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc5MSwiZXhwIjoxNzE5MjU1NTkxfQ.dRJdmJxf8RchfY6xsBtoMhxxTy5VZFKCN4i-gBZv_JQ' \
    -H 'Content-Type: application/json'

Get VIQ info

GET /account/viq

HTTP Request

GET /account/viq HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc5NiwiZXhwIjoxNzE5MjU1NTk2fQ.Q37qLHafj4uGH01qfq71RJdPk3gj5gd-TrY7-uGkpxU

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.

licenses[].devices

Number

The device number.

licenses[].activated

Number

The activated device number.

licenses[].available

Number

The available device number.

licenses[].license_type

String

The Gemalto license type.

partner_id

String

The partner ID

partner_email

String

The partner email

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
RateLimit-Remaining: 7355
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Content-Length: 1206

{
  "devices" : 10,
  "standalone" : true,
  "expired" : false,
  "customer_id" : "zzzzz-zzzzz-zzzzz-zzzzz-zzzzz-zzzzz",
  "vhm_id" : "VHM-000001",
  "owner_id" : 102,
  "licenses" : [ {
    "id" : 1,
    "create_time" : "2024-06-17T18:59:56.000+0000",
    "update_time" : "2024-06-17T18:59:56.000+0000",
    "status" : "EVAL",
    "active_date" : "2024-06-17T18:59:56.000+0000",
    "expire_date" : "2025-06-17T18:59:56.000+0000",
    "entitlement_key" : "zzzzz-wwwww-wwwww-wwwww-wwwww-zzzzz",
    "entitlement_type" : "EVALUATION",
    "mode" : "EVAL",
    "devices" : 10,
    "activated" : 10,
    "available" : 100,
    "license_type" : "Legacy"
  }, {
    "id" : 112,
    "create_time" : "2024-04-17T18:59:56.000+0000",
    "update_time" : "2024-04-17T18:59:56.000+0000",
    "status" : "EVAL",
    "active_date" : "2024-05-17T18:59:56.000+0000",
    "expire_date" : "2024-06-10T18:59:56.000+0000",
    "entitlement_key" : "wwwww-wwwww-wwwww-wwwww-wwwww-wwwww",
    "entitlement_type" : "EVALUATION",
    "mode" : "EVAL",
    "devices" : 100,
    "activated" : 0,
    "available" : 0,
    "license_type" : ""
  } ],
  "partner_id" : "MSP-DZEDQVMZ",
  "partner_email" : "hbhatija@extremenetworks.com"
}

cURL Request

$ curl 'https://api.extremecloudiq.com/account/viq' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc5NiwiZXhwIjoxNzE5MjU1NTk2fQ.Q37qLHafj4uGH01qfq71RJdPk3gj5gd-TrY7-uGkpxU'

VIQ backup

POST /account/viq/:backup

HTTP Request

POST /account/viq/:backup HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc4NywiZXhwIjoxNzE5MjU1NTg3fQ.p-Dy2yGJMSxQvix-p1FJRJzhmWZOaOheaWImc8wPAbU
Content-Type: application/json

HTTP Response

HTTP/1.1 200 OK
RateLimit-Remaining: 7342
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

cURL Request

$ curl 'https://api.extremecloudiq.com/account/viq/:backup' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc4NywiZXhwIjoxNzE5MjU1NTg3fQ.p-Dy2yGJMSxQvix-p1FJRJzhmWZOaOheaWImc8wPAbU' \
    -H 'Content-Type: application/json'

Get default device password

GET /account/viq/default-device-password

HTTP Request

GET /account/viq/default-device-password HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc4NywiZXhwIjoxNzE5MjU1NTg3fQ.p-Dy2yGJMSxQvix-p1FJRJzhmWZOaOheaWImc8wPAbU
Content-Type: application/json

Response Fields

Path Type Description

password

String

The default device password.

HTTP Response

HTTP/1.1 200 OK
RateLimit-Remaining: 7342
Pragma: no-cache
Content-Length: 21
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "password" : ""
}

cURL Request

$ curl 'https://api.extremecloudiq.com/account/viq/default-device-password' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc4NywiZXhwIjoxNzE5MjU1NTg3fQ.p-Dy2yGJMSxQvix-p1FJRJzhmWZOaOheaWImc8wPAbU' \
    -H 'Content-Type: application/json'

Update Device Default Password

PUT /account/viq/default-device-password

HTTP Request

PUT /account/viq/default-device-password HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc4NywiZXhwIjoxNzE5MjU1NTg3fQ.p-Dy2yGJMSxQvix-p1FJRJzhmWZOaOheaWImc8wPAbU
Content-Type: application/json
Content-Length: 14

"'0qMFXrPXyD'"

HTTP Response

HTTP/1.1 200 OK
RateLimit-Remaining: 7341
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

cURL Request

$ curl 'https://api.extremecloudiq.com/account/viq/default-device-password' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc4NywiZXhwIjoxNzE5MjU1NTg3fQ.p-Dy2yGJMSxQvix-p1FJRJzhmWZOaOheaWImc8wPAbU' \
    -H 'Content-Type: application/json' \
    -d '"'0qMFXrPXyD'"'

VIQ Export

GET /account/viq/export

Request Parameters

Parameter Description

timeoutInSeconds

The maximum export duration

excludeDeviceFirmware

Whether exclude device firmwares from VIQ export file or not

HTTP Request

POST /account/viq/export HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc5NywiZXhwIjoxNzE5MjU1NTk3fQ.g-jwXrnJBz97uvhcQojewSJC6dYnu_pTVphUPOTryMU
Content-Type: application/json

timeoutInSeconds=1800

Response Fields

Path Type Description

export_status

String

The viq export status

export_file_name

String

The viq export report file name

log_file_name

String

The viq export log file name

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Remaining: 7354
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
Content-Length: 170
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "export_file_name" : "Exported_VHM-000001_20231220-043416.tar.gz",
  "log_file_name" : "Export_VHM-000001_20231220-070742.log",
  "export_status" : "EXPORT SUCCESS"
}

cURL Request

$ curl 'https://api.extremecloudiq.com/account/viq/export' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc5NywiZXhwIjoxNzE5MjU1NTk3fQ.g-jwXrnJBz97uvhcQojewSJC6dYnu_pTVphUPOTryMU' \
    -H 'Content-Type: application/json' \
    -d 'timeoutInSeconds=1800'

VIQ Import

GET /account/viq/import

Request Parameters

Parameter Description

timeoutInSeconds

The maximum import duration

resendUserNotifications

Resend Cloud PPSK/RADIUS password through email/SMS

HTTP Request

POST /account/viq/import HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: multipart/form-data; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Type: multipart/form-data; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc5NywiZXhwIjoxNzE5MjU1NTk3fQ.g-jwXrnJBz97uvhcQojewSJC6dYnu_pTVphUPOTryMU

--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=timeoutInSeconds

1800
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=importFile; filename=Imported.gz
Content-Type: application/x-tar+gzip


--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--

Response Fields

Path Type Description

import_status

String

The viq import status

log_file_name

String

The viq import log file name

HTTP Response

HTTP/1.1 200 OK
RateLimit-Remaining: 7352
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Content-Length: 101

{
  "log_file_name" : "Import_VHM-000001_20240114-210500.log",
  "import_status" : "IMPORT SUCCESS"
}

cURL Request

$ curl 'https://api.extremecloudiq.com/account/viq/import' -i -X POST \
    -H 'Content-Type: multipart/form-data' \
    -H 'Content-Type: multipart/form-data' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc5NywiZXhwIjoxNzE5MjU1NTk3fQ.g-jwXrnJBz97uvhcQojewSJC6dYnu_pTVphUPOTryMU' \
    -F 'importFile=@Imported.gz;type=application/x-tar+gzip' \
    -F 'timeoutInSeconds=1800'

VIQ Download

GET /account/viq/download

Request Parameters

Parameter Description

reportName

The report full name

HTTP Request

GET /account/viq/download?reportName=Exported_VHM-000001_20231220-043416.tar.gz HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc5NywiZXhwIjoxNzE5MjU1NTk3fQ.g-jwXrnJBz97uvhcQojewSJC6dYnu_pTVphUPOTryMU
Content-Type: application/json

HTTP Response

HTTP/1.1 200 OK
RateLimit-Remaining: 7353
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Disposition: attachment; filename=Exported_VHM-000001_20231220-043416.tar.gz
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 155
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Content-Type: application/octet-stream

/var/lib/jenkins/workspace/XIQ-RELEASE-BUILDS/RELEASE-24R4/xcloudiq-api/xcloudiq-api-gateway/target/test-classes/Exported_VHM-000001_20231220-043416.tar.gz

cURL Request

$ curl 'https://api.extremecloudiq.com/account/viq/download?reportName=Exported_VHM-000001_20231220-043416.tar.gz' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc5NywiZXhwIjoxNzE5MjU1NTk3fQ.g-jwXrnJBz97uvhcQojewSJC6dYnu_pTVphUPOTryMU' \
    -H 'Content-Type: application/json'

VIQ Export Import Status

GET /account/viq/export-import-status

Request Parameters

Parameter Description

viqOperationType

The type of operation to get status

HTTP Request

GET /account/viq/export-import-status?viqOperationType=EXPORT HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc5NywiZXhwIjoxNzE5MjU1NTk3fQ.g-jwXrnJBz97uvhcQojewSJC6dYnu_pTVphUPOTryMU
Content-Type: application/json

Response Fields

Path Type Description

user_name

String

User Name

vhm_id

String

VHM Id of the user

operation

String

Type of Operation export/import

status

String

Status of the request

total_finish_percentage

Number

Total finish percentage of the operation

viq_task_progresses[].task_name

String

Name of the task

viq_task_progresses[].finish_percentage

Number

Percentage of the task

viq_task_progresses[].detail

String

Detailed info of the task

viq_task_progresses[].status

String

Status of the task

HTTP Response

HTTP/1.1 200 OK
RateLimit-Remaining: 7352
Pragma: no-cache
Content-Length: 560
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "user_name" : "admin@cust001.com",
  "vhm_id" : "VHM-000001",
  "operation" : "EXPORT",
  "status" : "SUCCESS",
  "total_finish_percentage" : 100,
  "viq_task_progresses" : [ {
    "task_name" : "Suspend VIQ",
    "finish_percentage" : 100,
    "detail" : "Finished",
    "status" : "SUCCESS"
  }, {
    "task_name" : "Export VIQ Information",
    "finish_percentage" : 100,
    "detail" : "Finished",
    "status" : "SUCCESS"
  }, {
    "task_name" : "Resume VIQ",
    "finish_percentage" : 100,
    "detail" : "Finished",
    "status" : "SUCCESS"
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/account/viq/export-import-status?viqOperationType=EXPORT' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc5NywiZXhwIjoxNzE5MjU1NTk3fQ.g-jwXrnJBz97uvhcQojewSJC6dYnu_pTVphUPOTryMU' \
    -H 'Content-Type: application/json'

User

List users

GET /users

Request Parameters

Parameter Description

page

Page number

limit

Page size

HTTP Request

GET /users?page=1&limit=10 HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgxMywiZXhwIjoxNzE5MjU1NjEzfQ.laWEegjMtzGQ6DIihl3yhAxyyhamR9x04sXlt0Dz0NU

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 user ID.

data[].create_time

String

The create time.

data[].update_time

String

The last update time.

data[].login_name

String

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

data[].first_name

String

The first name.

data[].last_name

String

The last name, i.e. family name.

data[].display_name

String

The name to display.

data[].phone

String

The Phone Number.

data[].job_title

String

The job title.

data[].locale

String

The locale.

data[].idle_timeout

Number

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

data[].last_login_time

String

The last login time.

data[].org_id

Number

The HIQ org_id if it is HIQ user.

data[].user_role

String

The user role.

data[].location_ids

Array

The assigned location IDs.

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
RateLimit-Remaining: 7348
Content-Length: 1079
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 1,
  "total_count" : 2,
  "data" : [ {
    "id" : 1,
    "create_time" : "2024-06-17T19:00:13.000+0000",
    "update_time" : "2024-06-17T19:00:13.000+0000",
    "login_name" : "admin@cust001.com",
    "first_name" : "admin1",
    "last_name" : "admin",
    "display_name" : "Administrator",
    "phone" : "0",
    "job_title" : "IT",
    "locale" : "US",
    "user_role" : "ADMINISTRATOR",
    "idle_timeout" : 10,
    "last_login_time" : "2024-06-17T19:00:13.000+0000",
    "org_id" : 0,
    "location_ids" : [ 438086664193 ]
  }, {
    "id" : 2,
    "create_time" : "2024-06-17T19:00:13.000+0000",
    "update_time" : "2024-06-17T19:00:13.000+0000",
    "login_name" : "admin@cust002.com",
    "first_name" : "admin2",
    "last_name" : "admin",
    "display_name" : "Administrator",
    "phone" : "0",
    "job_title" : "IT",
    "locale" : "US",
    "user_role" : "ADMINISTRATOR",
    "idle_timeout" : 10,
    "last_login_time" : "2024-06-17T19:00:13.000+0000",
    "org_id" : 0,
    "location_ids" : [ 438086664193 ]
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/users?page=1&limit=10' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgxMywiZXhwIjoxNzE5MjU1NjEzfQ.laWEegjMtzGQ6DIihl3yhAxyyhamR9x04sXlt0Dz0NU'

Create new user

POST /users

Request Fields

Path Type Description

login_name

String

The login name

display_name

String

The display name

idle_timeout

Number

The idle timeout in minutes

user_role

String

The user administrative role

location_ids

Array

The location IDs to assign.

HTTP Request

POST /users HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgxMywiZXhwIjoxNzE5MjU1NjEzfQ.laWEegjMtzGQ6DIihl3yhAxyyhamR9x04sXlt0Dz0NU
Content-Length: 169

{
  "login_name" : "admin@cust001.com",
  "display_name" : "Administrator",
  "idle_timeout" : 10,
  "user_role" : "ADMINISTRATOR",
  "location_ids" : [ 438086664193 ]
}

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.

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_role

String

The user role.

location_ids

Array

The assigned location IDs.

HTTP Response

HTTP/1.1 201 Created
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
RateLimit-Remaining: 7349
Content-Length: 448
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "id" : 1,
  "create_time" : "2024-06-17T19:00:13.000+0000",
  "update_time" : "2024-06-17T19:00:13.000+0000",
  "login_name" : "admin@cust001.com",
  "first_name" : "admin1",
  "last_name" : "admin",
  "display_name" : "Administrator",
  "phone" : "0",
  "job_title" : "IT",
  "locale" : "US",
  "user_role" : "ADMINISTRATOR",
  "idle_timeout" : 10,
  "last_login_time" : "2024-06-17T19:00:13.000+0000",
  "org_id" : 0,
  "location_ids" : [ ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/users' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgxMywiZXhwIjoxNzE5MjU1NjEzfQ.laWEegjMtzGQ6DIihl3yhAxyyhamR9x04sXlt0Dz0NU' \
    -d '{
  "login_name" : "admin@cust001.com",
  "display_name" : "Administrator",
  "idle_timeout" : 10,
  "user_role" : "ADMINISTRATOR",
  "location_ids" : [ 438086664193 ]
}'

Get user

GET /users/{id}

Path parameters

Table 1. /users/{id}
Parameter Description

id

User ID

HTTP Request

GET /users/1 HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgxMywiZXhwIjoxNzE5MjU1NjEzfQ.laWEegjMtzGQ6DIihl3yhAxyyhamR9x04sXlt0Dz0NU

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.

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_role

String

The user role.

location_ids

Array

The assigned location IDs.

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
RateLimit-Remaining: 7344
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Length: 448
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "id" : 1,
  "create_time" : "2024-06-17T19:00:13.000+0000",
  "update_time" : "2024-06-17T19:00:13.000+0000",
  "login_name" : "admin@cust001.com",
  "first_name" : "admin1",
  "last_name" : "admin",
  "display_name" : "Administrator",
  "phone" : "0",
  "job_title" : "IT",
  "locale" : "US",
  "user_role" : "ADMINISTRATOR",
  "idle_timeout" : 10,
  "last_login_time" : "2024-06-17T19:00:13.000+0000",
  "org_id" : 0,
  "location_ids" : [ ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/users/1' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgxMywiZXhwIjoxNzE5MjU1NjEzfQ.laWEegjMtzGQ6DIihl3yhAxyyhamR9x04sXlt0Dz0NU'

Delete user

DELETE /users/{id}

Path Parameters

Table 2. /users/{id}
Parameter Description

id

The location ID

HTTP Request

DELETE /users/1 HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgxMiwiZXhwIjoxNzE5MjU1NjEyfQ.gycjBsW0il7UMlqIKGAolgU1eOw1sVh_uyjixIwYe_0

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
RateLimit-Remaining: 7350

cURL Request

$ curl 'https://api.extremecloudiq.com/users/1' -i -X DELETE \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgxMiwiZXhwIjoxNzE5MjU1NjEyfQ.gycjBsW0il7UMlqIKGAolgU1eOw1sVh_uyjixIwYe_0'

Update user

PATCH /users/{id}

Path Parameters

Table 3. /users/{id}
Parameter Description

id

The location ID

Request Fields

Path Type Description

login_name

String

The login name

display_name

String

The display name

idle_timeout

Number

The idle timeout in minutes

user_role

String

The user administrative role

location_ids

Array

The location IDs to assign.

HTTP Request

PATCH /users/1 HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgxMywiZXhwIjoxNzE5MjU1NjEzfQ.laWEegjMtzGQ6DIihl3yhAxyyhamR9x04sXlt0Dz0NU
Content-Length: 169

{
  "login_name" : "admin@cust001.com",
  "display_name" : "Administrator",
  "idle_timeout" : 10,
  "user_role" : "ADMINISTRATOR",
  "location_ids" : [ 438086664193 ]
}

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.

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_role

String

The user role.

location_ids

Array

The assigned location IDs.

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
Content-Length: 461
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
RateLimit-Remaining: 7346
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "id" : 1,
  "create_time" : "2024-06-17T19:00:13.000+0000",
  "update_time" : "2024-06-17T19:00:13.000+0000",
  "login_name" : "admin@cust001.com",
  "first_name" : "admin1",
  "last_name" : "admin",
  "display_name" : "Administrator",
  "phone" : "0",
  "job_title" : "IT",
  "locale" : "US",
  "user_role" : "ADMINISTRATOR",
  "idle_timeout" : 10,
  "last_login_time" : "2024-06-17T19:00:13.000+0000",
  "org_id" : 0,
  "location_ids" : [ 438086664193 ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/users/1' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgxMywiZXhwIjoxNzE5MjU1NjEzfQ.laWEegjMtzGQ6DIihl3yhAxyyhamR9x04sXlt0Dz0NU' \
    -d '{
  "login_name" : "admin@cust001.com",
  "display_name" : "Administrator",
  "idle_timeout" : 10,
  "user_role" : "ADMINISTRATOR",
  "location_ids" : [ 438086664193 ]
}'

List external users

GET /users/external

Request Parameters

Parameter Description

page

Page number

limit

Page size

HTTP Request

GET /users/external?page=1&limit=10 HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgxMywiZXhwIjoxNzE5MjU1NjEzfQ.laWEegjMtzGQ6DIihl3yhAxyyhamR9x04sXlt0Dz0NU

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 external user ID.

data[].create_time

String

The create time.

data[].update_time

String

The last update time.

data[].login_name

String

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

data[].org_id

Number

The HIQ org_id if it is HIQ user.

data[].user_role

String

The user role.

data[].location_ids

Array

The assigned location IDs.

data[].grantee_id

Number

The home VIQ user ID of external user.

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
RateLimit-Remaining: 7345
Expires: 0
Content-Length: 944
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 1,
  "total_count" : 3,
  "data" : [ {
    "id" : 1,
    "create_time" : "2024-06-17T19:00:13.000+0000",
    "update_time" : "2024-06-17T19:00:13.000+0000",
    "login_name" : "operator1@extermenetworks.com",
    "user_role" : "OPERATOR",
    "org_id" : 0,
    "location_ids" : [ 438086664193 ],
    "grantee_id" : 1
  }, {
    "id" : 2,
    "create_time" : "2024-06-17T19:00:13.000+0000",
    "update_time" : "2024-06-17T19:00:13.000+0000",
    "login_name" : "operator2@extermenetworks.com",
    "user_role" : "OPERATOR",
    "org_id" : 0,
    "location_ids" : [ 438086664193 ],
    "grantee_id" : 2
  }, {
    "id" : 3,
    "create_time" : "2024-06-17T19:00:13.000+0000",
    "update_time" : "2024-06-17T19:00:13.000+0000",
    "login_name" : "operator3@extermenetworks.com",
    "user_role" : "OPERATOR",
    "org_id" : 0,
    "location_ids" : [ 438086664193 ],
    "grantee_id" : 3
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/users/external?page=1&limit=10' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgxMywiZXhwIjoxNzE5MjU1NjEzfQ.laWEegjMtzGQ6DIihl3yhAxyyhamR9x04sXlt0Dz0NU'

Grant external user

POST /users/external

Request Fields

Path Type Description

login_name

String

The login name

user_role

String

The user administrative role

org_id

Number

The HIQ organization ID if it is HIQ user

location_ids

Array

The assigned location IDs.

HTTP Request

POST /users/external HTTP/1.1
Host: api.extremecloudiq.com
Content-Length: 117
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgxMywiZXhwIjoxNzE5MjU1NjEzfQ.laWEegjMtzGQ6DIihl3yhAxyyhamR9x04sXlt0Dz0NU

{
  "login_name" : "operator1@extremenetworks.com",
  "user_role" : "OPERATOR",
  "location_ids" : [ 438086664193 ]
}

Response Fields

Path Type Description

id

Number

External 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.

org_id

Number

The HIQ org_id if it is HIQ user.

user_role

String

The user role.

location_ids

Array

The assigned location IDs.

grantee_id

Number

The home VIQ user ID of external user.

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
Content-Length: 252
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
RateLimit-Remaining: 7340

{
  "id" : 1,
  "create_time" : "2024-06-17T19:00:13.000+0000",
  "update_time" : "2024-06-17T19:00:13.000+0000",
  "login_name" : "operator1@extermenetworks.com",
  "user_role" : "OPERATOR",
  "org_id" : 0,
  "location_ids" : [ ],
  "grantee_id" : 1
}

cURL Request

$ curl 'https://api.extremecloudiq.com/users/external' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgxMywiZXhwIjoxNzE5MjU1NjEzfQ.laWEegjMtzGQ6DIihl3yhAxyyhamR9x04sXlt0Dz0NU' \
    -d '{
  "login_name" : "operator1@extremenetworks.com",
  "user_role" : "OPERATOR",
  "location_ids" : [ 438086664193 ]
}'

Get external user

GET /users/external/{id}

Path parameters

Table 4. /users/external/{id}
Parameter Description

id

The external user ID

HTTP Request

GET /users/external/1 HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgxMywiZXhwIjoxNzE5MjU1NjEzfQ.laWEegjMtzGQ6DIihl3yhAxyyhamR9x04sXlt0Dz0NU

Response Fields

Path Type Description

id

Number

External 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.

org_id

Number

The HIQ org_id if it is HIQ user.

user_role

String

The user role.

location_ids

Array

The assigned location IDs.

grantee_id

Number

The home VIQ user ID of external user.

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
Content-Length: 252
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
RateLimit-Remaining: 7348
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "id" : 1,
  "create_time" : "2024-06-17T19:00:13.000+0000",
  "update_time" : "2024-06-17T19:00:13.000+0000",
  "login_name" : "operator1@extermenetworks.com",
  "user_role" : "OPERATOR",
  "org_id" : 0,
  "location_ids" : [ ],
  "grantee_id" : 1
}

cURL Request

$ curl 'https://api.extremecloudiq.com/users/external/1' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgxMywiZXhwIjoxNzE5MjU1NjEzfQ.laWEegjMtzGQ6DIihl3yhAxyyhamR9x04sXlt0Dz0NU'

Revoke external user

DELETE /users/external/{id}

Path Parameters

Table 5. /users/external/{id}
Parameter Description

id

The external user ID

HTTP Request

DELETE /users/external/1 HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgxMywiZXhwIjoxNzE5MjU1NjEzfQ.laWEegjMtzGQ6DIihl3yhAxyyhamR9x04sXlt0Dz0NU

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
RateLimit-Remaining: 7347
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

cURL Request

$ curl 'https://api.extremecloudiq.com/users/external/1' -i -X DELETE \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgxMywiZXhwIjoxNzE5MjU1NjEzfQ.laWEegjMtzGQ6DIihl3yhAxyyhamR9x04sXlt0Dz0NU'

Update external user

PATCH /users/external/{id}

Path Parameters

Table 6. /users/external/{id}
Parameter Description

id

The external user ID

Request Fields

Path Type Description

user_role

String

The user administrative role

org_id

Number

The HIQ organization ID if it is HIQ user

location_ids

Array

The location IDs to assign.

HTTP Request

PATCH /users/external/1 HTTP/1.1
Content-Length: 30
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgxMywiZXhwIjoxNzE5MjU1NjEzfQ.laWEegjMtzGQ6DIihl3yhAxyyhamR9x04sXlt0Dz0NU

{
  "user_role" : "OPERATOR"
}

HTTP Response

HTTP/1.1 200 OK
RateLimit-Remaining: 7341
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

cURL Request

$ curl 'https://api.extremecloudiq.com/users/external/1' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgxMywiZXhwIjoxNzE5MjU1NjEzfQ.laWEegjMtzGQ6DIihl3yhAxyyhamR9x04sXlt0Dz0NU' \
    -d '{
  "user_role" : "OPERATOR"
}'

Get current user

GET /users/me

HTTP Request

GET /user-profiles/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc3OCwiZXhwIjoxNzE5MjU1NTc4fQ.hkk4ShZKZDnwz9ceCfNOYVOzqBOgIR2TuxRpNxbMAow

Response Fields

Path Type Description

id

Number

The user profile ID.

name

String

The user profile name.

create_time

String

The create time of user profile.

update_time

String

The update time of user profile.

vlan_profile.id

Number

The vlan profile ID.

vlan_profile.org_id

Number

The vlan profile org ID.

vlan_profile.create_time

String

The create time.

vlan_profile.update_time

String

The last update time.

vlan_profile.name

String

The vlan profile name

vlan_profile.default_vlan_id

Number

The default vlan ID.

vlan_profile.enable_classification

Boolean

Enable classification.

vlan_profile.classified_entries[].id

Number

The classification entry id.

vlan_profile.classified_entries[].org_id

Number

The classification entry org id.

vlan_profile.classified_entries[].create_time

String

The create time of classified entry.

vlan_profile.classified_entries[].update_time

String

The update time of classified entry.

vlan_profile.classified_entries[].vlan_id

Number

The vlan ID.

vlan_profile.classified_entries[].classification_rule.id

Number

The classification assignment ID.

vlan_profile.classified_entries[].classification_rule.org_id

Number

The classification assignment org ID.

vlan_profile.classified_entries[].classification_rule.name

String

The classification assignment name.

vlan_profile.classified_entries[].classification_rule.description

String

The classification assignment description.

vlan_profile.classified_entries[].classification_rule.create_time

String

The create time of classification assignment.

vlan_profile.classified_entries[].classification_rule.update_time

String

The update time of classification assignment.

vlan_profile.classified_entries[].classification_rule.classifications[].id

Number

The classification ID.

vlan_profile.classified_entries[].classification_rule.classifications[].match

Boolean

Match or not match with classifications.

vlan_profile.classified_entries[].classification_rule.classifications[].value

String

The value of classification.

vlan_profile.classified_entries[].classification_rule.classifications[].create_time

String

The create time of classification.

vlan_profile.classified_entries[].classification_rule.classifications[].update_time

String

The update time of classification.

vlan_profile.classified_entries[].classification_rule.classifications[].classification_type

String

The classification type.

vlan_profile.classified_entries[].classification_rule.classifications[].classification_id

Number

The classification reference ID.

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
RateLimit-Remaining: 7410
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Length: 4475
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "id" : 1,
  "create_time" : "1970-01-01T00:00:00.000+0000",
  "update_time" : "1970-01-01T00:00:00.000+0000",
  "name" : "User_profile_",
  "vlan_profile" : {
    "id" : 1,
    "create_time" : "1970-01-01T00:00:00.000+0000",
    "update_time" : "1970-01-01T00:00:00.000+0000",
    "org_id" : 0,
    "name" : "VLAN_profile_",
    "default_vlan_id" : 0,
    "enable_classification" : false,
    "classified_entries" : [ {
      "id" : 0,
      "create_time" : "1970-01-01T00:00:00.000+0000",
      "update_time" : "1970-01-01T00:00:00.000+0000",
      "org_id" : 0,
      "vlan_id" : 0,
      "classification_rule" : {
        "id" : 1,
        "create_time" : "2024-06-17T18:59:38.000+0000",
        "update_time" : "2024-06-17T18:59:38.000+0000",
        "org_id" : 0,
        "name" : "10.0.0.1",
        "description" : "IP classification assignment",
        "classifications" : [ {
          "id" : 0,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        }, {
          "id" : 1,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        }, {
          "id" : 2,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        } ]
      }
    }, {
      "id" : 1,
      "create_time" : "1970-01-01T00:00:00.000+0000",
      "update_time" : "1970-01-01T00:00:00.000+0000",
      "org_id" : 0,
      "vlan_id" : 1,
      "classification_rule" : {
        "id" : 1,
        "create_time" : "2024-06-17T18:59:38.000+0000",
        "update_time" : "2024-06-17T18:59:38.000+0000",
        "org_id" : 0,
        "name" : "10.0.0.1",
        "description" : "IP classification assignment",
        "classifications" : [ {
          "id" : 0,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        }, {
          "id" : 1,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        }, {
          "id" : 2,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        } ]
      }
    }, {
      "id" : 2,
      "create_time" : "1970-01-01T00:00:00.000+0000",
      "update_time" : "1970-01-01T00:00:00.000+0000",
      "org_id" : 0,
      "vlan_id" : 2,
      "classification_rule" : {
        "id" : 1,
        "create_time" : "2024-06-17T18:59:38.000+0000",
        "update_time" : "2024-06-17T18:59:38.000+0000",
        "org_id" : 0,
        "name" : "10.0.0.1",
        "description" : "IP classification assignment",
        "classifications" : [ {
          "id" : 0,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        }, {
          "id" : 1,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        }, {
          "id" : 2,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        } ]
      }
    } ]
  }
}

cURL Request

$ curl 'https://api.extremecloudiq.com/user-profiles/438086664193' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc3OCwiZXhwIjoxNzE5MjU1NTc4fQ.hkk4ShZKZDnwz9ceCfNOYVOzqBOgIR2TuxRpNxbMAow'

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 context

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

GET /hiq/context

HTTP Request

GET /hiq/context HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc4MywiZXhwIjoxNzE5MjU1NTgzfQ.iG3mBnq-iLWiug7w8xAGKJA5UJZESe-OsskzDDOEf2Q
Content-Type: application/json

Response Fields

Path Type Description

reading_org_ids.[]

Array

The organization ID list for reading data (Empty means read data from all organizations in the HIQ).

creating_org_id

Number

The organization ID for creating new data.

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
RateLimit-Remaining: 7369
Content-Length: 62
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "reading_org_ids" : [ 1, 2, 3 ],
  "creating_org_id" : 1
}

cURL Request

$ curl 'https://api.extremecloudiq.com/hiq/context' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc4MywiZXhwIjoxNzE5MjU1NTgzfQ.iG3mBnq-iLWiug7w8xAGKJA5UJZESe-OsskzDDOEf2Q' \
    -H 'Content-Type: application/json'

Set HIQ context

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

PUT /hiq/context

Request Fields

Path Type Description

creating_org_id

Number

The organization ID for creating new data.

reading_org_ids

Array

The organization ID list for reading data (Empty means read data from all organizations in the HIQ).

HTTP Request

PUT /hiq/context HTTP/1.1
Host: api.extremecloudiq.com
Content-Length: 62
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc4MywiZXhwIjoxNzE5MjU1NTgzfQ.iG3mBnq-iLWiug7w8xAGKJA5UJZESe-OsskzDDOEf2Q
Content-Type: application/json

{
  "reading_org_ids" : [ 1, 2, 3 ],
  "creating_org_id" : 1
}

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
RateLimit-Remaining: 7370
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

cURL Request

$ curl 'https://api.extremecloudiq.com/hiq/context' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc4MywiZXhwIjoxNzE5MjU1NTgzfQ.iG3mBnq-iLWiug7w8xAGKJA5UJZESe-OsskzDDOEf2Q' \
    -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
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc4MywiZXhwIjoxNzE5MjU1NTgzfQ.iG3mBnq-iLWiug7w8xAGKJA5UJZESe-OsskzDDOEf2Q
Content-Type: application/json

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Content-Length: 1
RateLimit-Remaining: 7373

1

cURL Request

$ curl 'https://api.extremecloudiq.com/hiq/context/creating' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc4MywiZXhwIjoxNzE5MjU1NTgzfQ.iG3mBnq-iLWiug7w8xAGKJA5UJZESe-OsskzDDOEf2Q' \
    -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
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc4MywiZXhwIjoxNzE5MjU1NTgzfQ.iG3mBnq-iLWiug7w8xAGKJA5UJZESe-OsskzDDOEf2Q
Content-Type: application/json
Content-Length: 1

1

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
RateLimit-Remaining: 7371

cURL Request

$ curl 'https://api.extremecloudiq.com/hiq/context/creating' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc4MywiZXhwIjoxNzE5MjU1NTgzfQ.iG3mBnq-iLWiug7w8xAGKJA5UJZESe-OsskzDDOEf2Q' \
    -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
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc4MywiZXhwIjoxNzE5MjU1NTgzfQ.iG3mBnq-iLWiug7w8xAGKJA5UJZESe-OsskzDDOEf2Q
Content-Type: application/json

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Content-Length: 11
Expires: 0
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
RateLimit-Remaining: 7372

[ 1, 2, 3 ]

cURL Request

$ curl 'https://api.extremecloudiq.com/hiq/context/reading' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc4MywiZXhwIjoxNzE5MjU1NTgzfQ.iG3mBnq-iLWiug7w8xAGKJA5UJZESe-OsskzDDOEf2Q' \
    -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
Host: api.extremecloudiq.com
Content-Length: 11
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc4MywiZXhwIjoxNzE5MjU1NTgzfQ.iG3mBnq-iLWiug7w8xAGKJA5UJZESe-OsskzDDOEf2Q
Content-Type: application/json

[ 1, 2, 3 ]

HTTP Response

HTTP/1.1 200 OK
RateLimit-Remaining: 7374
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

cURL Request

$ curl 'https://api.extremecloudiq.com/hiq/context/reading' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc4MywiZXhwIjoxNzE5MjU1NTgzfQ.iG3mBnq-iLWiug7w8xAGKJA5UJZESe-OsskzDDOEf2Q' \
    -H 'Content-Type: application/json' \
    -d '[ 1, 2, 3 ]'

Get all organizations

GET /hiq/organizations

HTTP Request

GET /hiq/organizations HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc4NCwiZXhwIjoxNzE5MjU1NTg0fQ.-uuuSIcj5C3qsWb-Q3--WkuvvTf7xip50-52jkEu1pE
Content-Type: application/json

Response Fields

Path Type Description

[].id

Number

The unique identifier.

[].create_time

String

The create time.

[].update_time

String

The last update time.

[].org_id

Number

The organization identifier, valid when enabling HIQ feature.

[].name

String

The organization name.

[].type

class com.extremecloudiq.grpc.hiq.v1.OrganizationType

The organization type.

[].color

String

tagged color for the organization.

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
RateLimit-Remaining: 7366
X-XSS-Protection: 1; mode=block
Expires: 0
Content-Length: 2024
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

[ {
  "id" : 1,
  "create_time" : "2024-06-17T18:59:44.000+0000",
  "update_time" : "2024-06-17T18:59:44.000+0000",
  "org_id" : 1,
  "name" : "Example-corp-0",
  "type" : "REGULAR",
  "color" : "red"
}, {
  "id" : 2,
  "create_time" : "2024-06-17T18:59:44.000+0000",
  "update_time" : "2024-06-17T18:59:44.000+0000",
  "org_id" : 2,
  "name" : "Example-corp-1",
  "type" : "REGULAR",
  "color" : "red"
}, {
  "id" : 3,
  "create_time" : "2024-06-17T18:59:44.000+0000",
  "update_time" : "2024-06-17T18:59:44.000+0000",
  "org_id" : 3,
  "name" : "Example-corp-2",
  "type" : "REGULAR",
  "color" : "red"
}, {
  "id" : 4,
  "create_time" : "2024-06-17T18:59:44.000+0000",
  "update_time" : "2024-06-17T18:59:44.000+0000",
  "org_id" : 4,
  "name" : "Example-corp-3",
  "type" : "REGULAR",
  "color" : "red"
}, {
  "id" : 5,
  "create_time" : "2024-06-17T18:59:44.000+0000",
  "update_time" : "2024-06-17T18:59:44.000+0000",
  "org_id" : 5,
  "name" : "Example-corp-4",
  "type" : "REGULAR",
  "color" : "red"
}, {
  "id" : 6,
  "create_time" : "2024-06-17T18:59:44.000+0000",
  "update_time" : "2024-06-17T18:59:44.000+0000",
  "org_id" : 6,
  "name" : "Example-corp-5",
  "type" : "REGULAR",
  "color" : "red"
}, {
  "id" : 7,
  "create_time" : "2024-06-17T18:59:44.000+0000",
  "update_time" : "2024-06-17T18:59:44.000+0000",
  "org_id" : 7,
  "name" : "Example-corp-6",
  "type" : "REGULAR",
  "color" : "red"
}, {
  "id" : 8,
  "create_time" : "2024-06-17T18:59:44.000+0000",
  "update_time" : "2024-06-17T18:59:44.000+0000",
  "org_id" : 8,
  "name" : "Example-corp-7",
  "type" : "REGULAR",
  "color" : "red"
}, {
  "id" : 9,
  "create_time" : "2024-06-17T18:59:44.000+0000",
  "update_time" : "2024-06-17T18:59:44.000+0000",
  "org_id" : 9,
  "name" : "Example-corp-8",
  "type" : "REGULAR",
  "color" : "red"
}, {
  "id" : 10,
  "create_time" : "2024-06-17T18:59:44.000+0000",
  "update_time" : "2024-06-17T18:59:44.000+0000",
  "org_id" : 10,
  "name" : "Example-corp-9",
  "type" : "REGULAR",
  "color" : "red"
} ]

cURL Request

$ curl 'https://api.extremecloudiq.com/hiq/organizations' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc4NCwiZXhwIjoxNzE5MjU1NTg0fQ.-uuuSIcj5C3qsWb-Q3--WkuvvTf7xip50-52jkEu1pE' \
    -H 'Content-Type: application/json'

Create organization

POST /hiq/organizations

Request Fields

Path Type Description

name

String

The organization name, must be unique in VIQ.

color

String

The tagged color for the organization.

HTTP Request

POST /hiq/organizations HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc4NCwiZXhwIjoxNzE5MjU1NTg0fQ.-uuuSIcj5C3qsWb-Q3--WkuvvTf7xip50-52jkEu1pE
Content-Type: application/json
Content-Length: 56

{
  "name" : "example-organization",
  "color" : "red"
}

Response Fields

Path Type Description

id

Number

The unique identifier.

create_time

String

The create time.

update_time

String

The last update time.

org_id

Number

The organization identifier, valid when enabling HIQ feature.

name

String

The organization name.

type

class com.extremecloudiq.grpc.hiq.v1.OrganizationType

The organization type.

color

String

tagged color for the organization.

HTTP Response

HTTP/1.1 201 Created
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
RateLimit-Remaining: 7368
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 199
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "id" : 1,
  "create_time" : "2024-06-17T18:59:44.000+0000",
  "update_time" : "2024-06-17T18:59:44.000+0000",
  "org_id" : 1,
  "name" : "Example-corp-",
  "type" : "REGULAR",
  "color" : "red"
}

cURL Request

$ curl 'https://api.extremecloudiq.com/hiq/organizations' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc4NCwiZXhwIjoxNzE5MjU1NTg0fQ.-uuuSIcj5C3qsWb-Q3--WkuvvTf7xip50-52jkEu1pE' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "example-organization",
  "color" : "red"
}'

Delete organization

DELETE /hiq/organizations/{id}

Path Parameters

Table 7. /hiq/organizations/{id}
Parameter Description

id

Organization ID to delete.

HTTP Request

DELETE /hiq/organizations/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc4NCwiZXhwIjoxNzE5MjU1NTg0fQ.-uuuSIcj5C3qsWb-Q3--WkuvvTf7xip50-52jkEu1pE
Content-Type: application/json

HTTP Response

HTTP/1.1 204 No Content
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
RateLimit-Remaining: 7369
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

cURL Request

$ curl 'https://api.extremecloudiq.com/hiq/organizations/438086664193' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc4NCwiZXhwIjoxNzE5MjU1NTg0fQ.-uuuSIcj5C3qsWb-Q3--WkuvvTf7xip50-52jkEu1pE' \
    -H 'Content-Type: application/json'

Rename organization

POST /hiq/organizations/{id}/:rename

Path Parameters

Table 8. /hiq/organizations/{id}/:rename
Parameter Description

id

Organization ID to delete.

HTTP Request

POST /hiq/organizations/438086664193/:rename HTTP/1.1
Host: api.extremecloudiq.com
Content-Length: 21
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc4NCwiZXhwIjoxNzE5MjU1NTg0fQ.-uuuSIcj5C3qsWb-Q3--WkuvvTf7xip50-52jkEu1pE
Content-Type: application/json

New organization name

HTTP Response

HTTP/1.1 204 No Content
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
RateLimit-Remaining: 7367
Expires: 0
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

cURL Request

$ curl 'https://api.extremecloudiq.com/hiq/organizations/438086664193/:rename' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc4NCwiZXhwIjoxNzE5MjU1NTg0fQ.-uuuSIcj5C3qsWb-Q3--WkuvvTf7xip50-52jkEu1pE' \
    -H 'Content-Type: application/json' \
    -d 'New organization name'

Get HIQ status

GET /hiq/status

HTTP Request

GET /hiq/status HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc4NCwiZXhwIjoxNzE5MjU1NTg0fQ.-uuuSIcj5C3qsWb-Q3--WkuvvTf7xip50-52jkEu1pE
Content-Type: application/json

Response Fields

Path Type Description

enabled

Boolean

Whether HIQ is enabled or not.

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
RateLimit-Remaining: 7366
X-XSS-Protection: 1; mode=block
Content-Length: 22
Expires: 0
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "enabled" : true
}

cURL Request

$ curl 'https://api.extremecloudiq.com/hiq/status' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDc4NCwiZXhwIjoxNzE5MjU1NTg0fQ.-uuuSIcj5C3qsWb-Q3--WkuvvTf7xip50-52jkEu1pE' \
    -H 'Content-Type: application/json'

Location

Initialize location

POST /locations/:init

Request Fields

Path Type Description

organization

String

The organization name

country

String

The organization country code

HTTP Request

POST /locations/:init HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzMiwiZXhwIjoxNzE5MjU1NjMyfQ.cwEz1D-ttKAnn_E_-UZw-ZynhV7Qls8hwNDM3MARiXA
Content-Length: 67

{
  "organization" : "Extreme Org",
  "country" : "AFGHANISTAN_4"
}

Response Fields

Path Type Description

id

Number

The location 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

name

String

The location name

unique_name

String

The location unique name

parent_id

Number

The parent location ID

type

String

The location type

address

String

The location address

children[].id

Number

The children location ID

children[].create_time

String

The create time of children location

children[].update_time

String

The last update time of children location

children[].org_id

Number

The organization identifier for children location, valid when enabling HIQ feature

children[].name

String

The name of children location

children[].unique_name

String

The unique name of children location

children[].parent_id

Number

The parent location ID of children location

children[].type

String

The type of children location

children[].address

String

The location address of children location

children[].children

Array

The children of children location

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Content-Length: 674
RateLimit-Remaining: 7274

{
  "id" : 438086664193,
  "create_time" : "2024-06-17T19:00:33.000+0000",
  "update_time" : "2024-06-17T19:00:33.000+0000",
  "org_id" : 0,
  "name" : "Extreme Org",
  "unique_name" : "Extreme Org",
  "type" : "Location",
  "address" : "addressLine1, addressLine2, city, state, postalCode",
  "children" : [ {
    "id" : 438086665192,
    "create_time" : "2024-06-17T19:00:33.000+0000",
    "update_time" : "2024-06-17T19:00:33.000+0000",
    "org_id" : 0,
    "parent_id" : 438086674192,
    "name" : "test-loc-1",
    "unique_name" : "test-loc1",
    "type" : "Location",
    "address" : "addressLine1, addressLine2, city, state, postalCode",
    "children" : [ ]
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/locations/:init' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzMiwiZXhwIjoxNzE5MjU1NjMyfQ.cwEz1D-ttKAnn_E_-UZw-ZynhV7Qls8hwNDM3MARiXA' \
    -d '{
  "organization" : "Extreme Org",
  "country" : "AFGHANISTAN_4"
}'

Create location

POST /locations

Request Fields

Path Type Description

name

String

The location name

parent_id

Number

The parent location ID

HTTP Request

POST /locations HTTP/1.1
Host: api.extremecloudiq.com
Content-Length: 44
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzNCwiZXhwIjoxNzE5MjU1NjM0fQ.0nZT8ZM21l3oW0kbVZBUWczzOvhbmYOR1UZoNSksZO0

{
  "parent_id" : 1,
  "name" : "test-loc"
}

Response Fields

Path Type Description

id

Number

The location 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

name

String

The location name

unique_name

String

The location unique name

parent_id

Number

The location parent ID

type

String

The location type

address

String

The location address

children[].id

Number

The children location ID

children[].create_time

String

The create time of children location

children[].update_time

String

The last update time of children location

children[].org_id

Number

The organization identifier for children location, valid when enabling HIQ feature

children[].name

String

The name of children location

children[].unique_name

String

The unique name of children location

children[].parent_id

Number

The parent location ID of children location

children[].type

String

The type of children location

children[].address

String

The location address of children

children[].children

Array

The children of children location

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Length: 677
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
RateLimit-Remaining: 7262

{
  "id" : 438086664193,
  "create_time" : "2024-06-17T19:00:34.000+0000",
  "update_time" : "2024-06-17T19:00:34.000+0000",
  "org_id" : 0,
  "parent_id" : 1,
  "name" : "test-loc",
  "unique_name" : "test-loc",
  "type" : "loc",
  "address" : "addressLine1, addressLine2, city, state, postalCode",
  "children" : [ {
    "id" : 438086665192,
    "create_time" : "2024-06-17T19:00:34.000+0000",
    "update_time" : "2024-06-17T19:00:34.000+0000",
    "org_id" : 0,
    "parent_id" : 438086674192,
    "name" : "test-loc-1",
    "unique_name" : "test-loc1",
    "type" : "loc",
    "address" : "addressLine1, addressLine2, city, state, postalCode",
    "children" : [ ]
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/locations' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzNCwiZXhwIjoxNzE5MjU1NjM0fQ.0nZT8ZM21l3oW0kbVZBUWczzOvhbmYOR1UZoNSksZO0' \
    -d '{
  "parent_id" : 1,
  "name" : "test-loc"
}'

Update location

PUT /locations/{id}

Path Parameters

Table 9. /locations/{id}
Parameter Description

id

The location ID

Request Fields

Path Type Description

name

String

The location name

parent_id

Number

The parent location ID

HTTP Request

PUT /locations/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzMiwiZXhwIjoxNzE5MjU1NjMyfQ.cwEz1D-ttKAnn_E_-UZw-ZynhV7Qls8hwNDM3MARiXA
Content-Length: 57

{
  "parent_id" : 438086664292,
  "name" : "test-loc-2"
}

Response Fields

Path Type Description

id

Number

The location 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

name

String

The location name

unique_name

String

The location unique name

parent_id

Number

The parent location ID

type

String

The location type

address

String

The location address

children[].id

Number

The children location ID

children[].create_time

String

The create time of children location

children[].update_time

String

The last update time of children location

children[].org_id

Number

The organization identifier for children location, valid when enabling HIQ feature

children[].name

String

The name of children location

children[].unique_name

String

The unique name of children location

children[].parent_id

Number

The parent location ID of children location

children[].type

String

The type of children location

children[].address

String

The location address of children location

children[].children

Array

The children of children location

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Remaining: 7277
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Length: 677
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "id" : 438086664193,
  "create_time" : "2024-06-17T19:00:32.000+0000",
  "update_time" : "2024-06-17T19:00:32.000+0000",
  "org_id" : 0,
  "parent_id" : 1,
  "name" : "test-loc",
  "unique_name" : "test-loc",
  "type" : "loc",
  "address" : "addressLine1, addressLine2, city, state, postalCode",
  "children" : [ {
    "id" : 438086665192,
    "create_time" : "2024-06-17T19:00:32.000+0000",
    "update_time" : "2024-06-17T19:00:32.000+0000",
    "org_id" : 0,
    "parent_id" : 438086674192,
    "name" : "test-loc-1",
    "unique_name" : "test-loc1",
    "type" : "loc",
    "address" : "addressLine1, addressLine2, city, state, postalCode",
    "children" : [ ]
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/locations/438086664193' -i -X PUT \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzMiwiZXhwIjoxNzE5MjU1NjMyfQ.cwEz1D-ttKAnn_E_-UZw-ZynhV7Qls8hwNDM3MARiXA' \
    -d '{
  "parent_id" : 438086664292,
  "name" : "test-loc-2"
}'

Delete location

DELETE /locations/{id}

Path Parameters

Table 10. /locations/{id}
Parameter Description

id

The location ID

Request parameters

Parameter Description

force_delete

Force deletion of this location and its descendants recursively

HTTP Request

DELETE /locations/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzNCwiZXhwIjoxNzE5MjU1NjM0fQ.0nZT8ZM21l3oW0kbVZBUWczzOvhbmYOR1UZoNSksZO0

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
RateLimit-Remaining: 7263

cURL Request

$ curl 'https://api.extremecloudiq.com/locations/438086664193' -i -X DELETE \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzNCwiZXhwIjoxNzE5MjU1NjM0fQ.0nZT8ZM21l3oW0kbVZBUWczzOvhbmYOR1UZoNSksZO0'

Create building

POST /locations/building

Request Fields

Path Type Description

name

String

The building name

parent_id

Number

The parent location ID

address.address

String

The building address line1

address.address2

String

The building address line2

address.city

String

The building address city

address.state

String

The building address state

address.postal_code

String

The building address postal/zip code

latitude

Number

The latitude coordinate for the building

longitude

Number

The longitude coordinate for the building

HTTP Request

POST /locations/building HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzNCwiZXhwIjoxNzE5MjU1NjM0fQ.0nZT8ZM21l3oW0kbVZBUWczzOvhbmYOR1UZoNSksZO0
Content-Length: 287

{
  "parent_id" : 438086664292,
  "name" : "test-building",
  "address" : {
    "address" : "addressLine1",
    "address2" : "addressLine2",
    "city" : "city",
    "state" : "state",
    "postal_code" : "postalCode"
  },
  "latitude" : 37.23846552983368,
  "longitude" : -121.7852542
}

Response Fields

Path Type Description

id

Number

The building 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

name

String

The building name

parent_id

Number

The parent location ID

address.address

String

The building address line1

address.address2

String

The building address line2

address.city

String

The building address city

address.state

String

The building address state

address.postal_code

String

The building address postal/zip code

latitude

Number

The latitude coordinate for the building

longitude

Number

The longitude coordinate for the building

HTTP Response

HTTP/1.1 200 OK
RateLimit-Remaining: 7264
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 426
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "id" : 438086664193,
  "create_time" : "2024-06-17T19:00:34.000+0000",
  "update_time" : "2024-06-17T19:00:34.000+0000",
  "org_id" : 0,
  "parent_id" : 438086664292,
  "name" : "test-building",
  "address" : {
    "address" : "addressLine1",
    "address2" : "addressLine2",
    "city" : "city",
    "state" : "state",
    "postal_code" : "postalCode"
  },
  "latitude" : 37.23846552983368,
  "longitude" : -121.7852542
}

cURL Request

$ curl 'https://api.extremecloudiq.com/locations/building' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzNCwiZXhwIjoxNzE5MjU1NjM0fQ.0nZT8ZM21l3oW0kbVZBUWczzOvhbmYOR1UZoNSksZO0' \
    -d '{
  "parent_id" : 438086664292,
  "name" : "test-building",
  "address" : {
    "address" : "addressLine1",
    "address2" : "addressLine2",
    "city" : "city",
    "state" : "state",
    "postal_code" : "postalCode"
  },
  "latitude" : 37.23846552983368,
  "longitude" : -121.7852542
}'

Update building

PUT /locations/building/{id}

Path Parameters

Table 11. /locations/building/{id}
Parameter Description

id

The location ID

Request Fields

Path Type Description

name

String

The building name

parent_id

Number

The parent location ID

address.address

String

The building address line1

address.address2

String

The building address line2

address.city

String

The building address city

address.state

String

The building address state

address.postal_code

String

The building address postal/zip code

latitude

Number

The latitude coordinate for the building

longitude

Number

The longitude coordinate for the building

HTTP Request

PUT /locations/building/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzMiwiZXhwIjoxNzE5MjU1NjMyfQ.cwEz1D-ttKAnn_E_-UZw-ZynhV7Qls8hwNDM3MARiXA
Content-Length: 287

{
  "parent_id" : 438086664292,
  "name" : "test-building",
  "address" : {
    "address" : "addressLine1",
    "address2" : "addressLine2",
    "city" : "city",
    "state" : "state",
    "postal_code" : "postalCode"
  },
  "latitude" : 37.23846552983368,
  "longitude" : -121.7852542
}

Response Fields

Path Type Description

id

Number

The building 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

name

String

The building name

parent_id

Number

The parent location ID

address.address

String

The building address line1

address.address2

String

The building address line2

address.city

String

The building address city

address.state

String

The building address state

address.postal_code

String

The building address postal/zip code

latitude

Number

The latitude coordinate for the building

longitude

Number

The longitude coordinate for the building

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
RateLimit-Remaining: 7278
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 426
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "id" : 438086664193,
  "create_time" : "2024-06-17T19:00:32.000+0000",
  "update_time" : "2024-06-17T19:00:32.000+0000",
  "org_id" : 0,
  "parent_id" : 438086664292,
  "name" : "test-building",
  "address" : {
    "address" : "addressLine1",
    "address2" : "addressLine2",
    "city" : "city",
    "state" : "state",
    "postal_code" : "postalCode"
  },
  "latitude" : 37.23846552983368,
  "longitude" : -121.7852542
}

cURL Request

$ curl 'https://api.extremecloudiq.com/locations/building/438086664193' -i -X PUT \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzMiwiZXhwIjoxNzE5MjU1NjMyfQ.cwEz1D-ttKAnn_E_-UZw-ZynhV7Qls8hwNDM3MARiXA' \
    -d '{
  "parent_id" : 438086664292,
  "name" : "test-building",
  "address" : {
    "address" : "addressLine1",
    "address2" : "addressLine2",
    "city" : "city",
    "state" : "state",
    "postal_code" : "postalCode"
  },
  "latitude" : 37.23846552983368,
  "longitude" : -121.7852542
}'

Delete building

DELETE /locations/building/{id}

Path Parameters

Table 12. /locations/building/{id}
Parameter Description

id

The location ID

Request parameters

Parameter Description

force_delete

Force deletion of this building and its descendants recursively

HTTP Request

DELETE /locations/building/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzNCwiZXhwIjoxNzE5MjU1NjM0fQ.0nZT8ZM21l3oW0kbVZBUWczzOvhbmYOR1UZoNSksZO0

HTTP Response

HTTP/1.1 200 OK
RateLimit-Remaining: 7265
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

cURL Request

$ curl 'https://api.extremecloudiq.com/locations/building/438086664193' -i -X DELETE \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzNCwiZXhwIjoxNzE5MjU1NjM0fQ.0nZT8ZM21l3oW0kbVZBUWczzOvhbmYOR1UZoNSksZO0'

List buildings

GET /locations/building

Request parameters

Parameter Description

page

Page number

limit

Page size

name

order

The sort order by name (ascending by default)

HTTP Request

GET /locations/building?page=1&limit=100&name=Test1&order=ASC HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzMywiZXhwIjoxNzE5MjU1NjMzfQ.5uMeyvoxZU2Wh3VxtwDwFmHz0r0Yc-KS7Sy7jfbiCnA

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 building 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[].name

String

The building name

data[].parent_id

Number

The parent location ID

data[].address.address

String

The building address line1

data[].address.address2

String

The building address line2

data[].address.city

String

The building address city

data[].address.state

String

The building address state

data[].address.postal_code

String

The building address postal/zip code

data[].latitude

Number

The latitude coordinate for the building

data[].longitude

Number

The longitude coordinate for the building

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Remaining: 7266
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
Content-Length: 548
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "page" : 1,
  "count" : 0,
  "total_pages" : 0,
  "total_count" : 0,
  "data" : [ {
    "id" : 438086664193,
    "create_time" : "2024-06-17T19:00:33.000+0000",
    "update_time" : "2024-06-17T19:00:33.000+0000",
    "org_id" : 0,
    "parent_id" : 438086664292,
    "name" : "test-building",
    "address" : {
      "address" : "addressLine1",
      "address2" : "addressLine2",
      "city" : "city",
      "state" : "state",
      "postal_code" : "postalCode"
    },
    "latitude" : 37.23846552983368,
    "longitude" : -121.7852542
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/locations/building?page=1&limit=100&name=Test1&order=ASC' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzMywiZXhwIjoxNzE5MjU1NjMzfQ.5uMeyvoxZU2Wh3VxtwDwFmHz0r0Yc-KS7Sy7jfbiCnA'

Create site

POST /locations/site

Request Fields

Path Type Description

name

String

The site name

parent_id

Number

The parent site group ID. The new site will be assigned to the root site group when this field is not present.

address.address

String

The site address line1

address.address2

String

The site address line2

address.city

String

The site address city

address.state

String

The site address state

address.postal_code

String

The site address postal/zip code

country_code

Number

The country code for the site

latitude

Number

The latitude coordinate for the site

longitude

Number

The longitude coordinate for the site

HTTP Request

POST /locations/site HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzMywiZXhwIjoxNzE5MjU1NjMzfQ.5uMeyvoxZU2Wh3VxtwDwFmHz0r0Yc-KS7Sy7jfbiCnA
Content-Length: 310

{
  "parent_id" : 438086664292,
  "name" : "test-building",
  "address" : {
    "address" : "addressLine1",
    "address2" : "addressLine2",
    "city" : "city",
    "state" : "state",
    "postal_code" : "postalCode"
  },
  "country_code" : 62,
  "latitude" : 37.23846552983368,
  "longitude" : -121.7852542
}

Response Fields

Path Type Description

id

Number

The site 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

name

String

The site name

unique_name

String

The site unique name

parent_id

Number

The site parent ID

type

String

The location type

address.address

String

The site address line1

address.address2

String

The site address line2

address.city

String

The site address city

address.state

String

The site address state

address.postal_code

String

The site address postal/zip code

country_code

Number

The country code for the site

created_by

Number

The user ID used to create the site

latitude

Number

The latitude coordinate for the site

longitude

Number

The longitude coordinate for the site

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
RateLimit-Remaining: 7267
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Length: 516
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "id" : 438086664193,
  "create_time" : "2024-06-17T19:00:33.000+0000",
  "update_time" : "2024-06-17T19:00:33.000+0000",
  "org_id" : 0,
  "parent_id" : 438086664292,
  "name" : "test-loc",
  "unique_name" : "test-loc",
  "type" : "INDOOR",
  "address" : {
    "address" : "addressLine1",
    "address2" : "addressLine2",
    "city" : "city",
    "state" : "state",
    "postal_code" : "postalCode"
  },
  "country_code" : 840,
  "created_by" : 1,
  "latitude" : 37.23846552983368,
  "longitude" : -121.7852542
}

cURL Request

$ curl 'https://api.extremecloudiq.com/locations/site' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzMywiZXhwIjoxNzE5MjU1NjMzfQ.5uMeyvoxZU2Wh3VxtwDwFmHz0r0Yc-KS7Sy7jfbiCnA' \
    -d '{
  "parent_id" : 438086664292,
  "name" : "test-building",
  "address" : {
    "address" : "addressLine1",
    "address2" : "addressLine2",
    "city" : "city",
    "state" : "state",
    "postal_code" : "postalCode"
  },
  "country_code" : 62,
  "latitude" : 37.23846552983368,
  "longitude" : -121.7852542
}'

Update site

PUT /locations/site/{id}

Path Parameters

Table 13. /locations/site/{id}
Parameter Description

id

The site ID

Request Fields

Path Type Description

name

String

The site name

parent_id

Number

The parent site group ID. The current site will be assigned to the root site group when this field is not present.

address.address

String

The site address line1

address.address2

String

The site address line2

address.city

String

The site address city

address.state

String

The site address state

address.postal_code

String

The site address postal/zip code

country_code

Number

The country code for the site

latitude

Number

The latitude coordinate for the site

longitude

Number

The longitude coordinate for the site

HTTP Request

PUT /locations/site/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzMiwiZXhwIjoxNzE5MjU1NjMyfQ.cwEz1D-ttKAnn_E_-UZw-ZynhV7Qls8hwNDM3MARiXA
Content-Length: 310

{
  "parent_id" : 438086664292,
  "name" : "test-building",
  "address" : {
    "address" : "addressLine1",
    "address2" : "addressLine2",
    "city" : "city",
    "state" : "state",
    "postal_code" : "postalCode"
  },
  "country_code" : 82,
  "latitude" : 37.23846552983368,
  "longitude" : -121.7852542
}

Response Fields

Path Type Description

id

Number

The site 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

name

String

The site name

unique_name

String

The site unique name

parent_id

Number

The site parent ID

type

String

The location type

address.address

String

The site address line1

address.address2

String

The site address line2

address.city

String

The site address city

address.state

String

The site address state

address.postal_code

String

The site address postal/zip code

country_code

Number

The country code for the site

created_by

Number

The user ID used to create the site

latitude

Number

The latitude coordinate for the site

longitude

Number

The longitude coordinate for the site

HTTP Response

HTTP/1.1 200 OK
RateLimit-Remaining: 7275
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Length: 516
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "id" : 438086664193,
  "create_time" : "2024-06-17T19:00:32.000+0000",
  "update_time" : "2024-06-17T19:00:32.000+0000",
  "org_id" : 0,
  "parent_id" : 438086664292,
  "name" : "test-loc",
  "unique_name" : "test-loc",
  "type" : "INDOOR",
  "address" : {
    "address" : "addressLine1",
    "address2" : "addressLine2",
    "city" : "city",
    "state" : "state",
    "postal_code" : "postalCode"
  },
  "country_code" : 840,
  "created_by" : 1,
  "latitude" : 37.23846552983368,
  "longitude" : -121.7852542
}

cURL Request

$ curl 'https://api.extremecloudiq.com/locations/site/438086664193' -i -X PUT \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzMiwiZXhwIjoxNzE5MjU1NjMyfQ.cwEz1D-ttKAnn_E_-UZw-ZynhV7Qls8hwNDM3MARiXA' \
    -d '{
  "parent_id" : 438086664292,
  "name" : "test-building",
  "address" : {
    "address" : "addressLine1",
    "address2" : "addressLine2",
    "city" : "city",
    "state" : "state",
    "postal_code" : "postalCode"
  },
  "country_code" : 82,
  "latitude" : 37.23846552983368,
  "longitude" : -121.7852542
}'

Delete site

DELETE /locations/site/{id}

Path Parameters

Table 14. /locations/site/{id}
Parameter Description

id

The site ID

Request parameters

Parameter Description

force_delete

Force deletion of this location and its descendants recursively

HTTP Request

DELETE /locations/site/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzMywiZXhwIjoxNzE5MjU1NjMzfQ.5uMeyvoxZU2Wh3VxtwDwFmHz0r0Yc-KS7Sy7jfbiCnA

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
RateLimit-Remaining: 7268
Expires: 0
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

cURL Request

$ curl 'https://api.extremecloudiq.com/locations/site/438086664193' -i -X DELETE \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzMywiZXhwIjoxNzE5MjU1NjMzfQ.5uMeyvoxZU2Wh3VxtwDwFmHz0r0Yc-KS7Sy7jfbiCnA'

Get site

Get /locations/site/{id}

Path parameters

Table 15. /locations/site/{id}
Parameter Description

id

The site ID

HTTP Request

GET /locations/site/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzMywiZXhwIjoxNzE5MjU1NjMzfQ.5uMeyvoxZU2Wh3VxtwDwFmHz0r0Yc-KS7Sy7jfbiCnA

Response Fields

Path Type Description

id

Number

The site 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

name

String

The site name

unique_name

String

The site unique name

type

String

The location type

created_by

Number

The user ID used to create the site

latitude

Number

The latitude coordinate for the site address

longitude

Number

The longitude coordinate for the site address

parent_id

Number

The site parent ID

address.address

String

The site address line1

address.address2

String

The site address line2

address.city

String

The site address city

address.state

String

The site address state

address.postal_code

String

The site address postal/zip code

country_code

Number

The country code for the site

created_by

Number

The user ID used to create the site

latitude

Number

The latitude coordinate for the site

longitude

Number

The longitude coordinate for the site

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Length: 516
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
RateLimit-Remaining: 7271
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "id" : 438086664193,
  "create_time" : "2024-06-17T19:00:33.000+0000",
  "update_time" : "2024-06-17T19:00:33.000+0000",
  "org_id" : 0,
  "parent_id" : 438086664292,
  "name" : "test-loc",
  "unique_name" : "test-loc",
  "type" : "INDOOR",
  "address" : {
    "address" : "addressLine1",
    "address2" : "addressLine2",
    "city" : "city",
    "state" : "state",
    "postal_code" : "postalCode"
  },
  "country_code" : 840,
  "created_by" : 1,
  "latitude" : 37.23846552983368,
  "longitude" : -121.7852542
}

cURL Request

$ curl 'https://api.extremecloudiq.com/locations/site/438086664193' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzMywiZXhwIjoxNzE5MjU1NjMzfQ.5uMeyvoxZU2Wh3VxtwDwFmHz0r0Yc-KS7Sy7jfbiCnA'

List sites

GET /locations/site

Request parameters

Parameter Description

page

Page number

limit

Page size

name

order

The sort order by name (ascending by default)

HTTP Request

GET /locations/site?page=1&limit=100&name=Test1&order=ASC HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzMiwiZXhwIjoxNzE5MjU1NjMyfQ.cwEz1D-ttKAnn_E_-UZw-ZynhV7Qls8hwNDM3MARiXA

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 site 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[].name

String

The site name

data[].unique_name

String

The site unique name

data[].parent_id

Number

The site parent ID

data[].type

String

The location type

data[].address.address

String

The site address line1

data[].address.address2

String

The site address line2

data[].address.city

String

The site address city

data[].address.state

String

The site address state

data[].address.postal_code

String

The site address postal/zip code

data[].country_code

Number

The country code for the site

data[].created_by

Number

The user ID used to create the site

data[].latitude

Number

The latitude coordinate for the site

data[].longitude

Number

The longitude coordinate for the site

HTTP Response

HTTP/1.1 200 OK
RateLimit-Remaining: 7275
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 646
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "page" : 1,
  "count" : 0,
  "total_pages" : 0,
  "total_count" : 0,
  "data" : [ {
    "id" : 438086664193,
    "create_time" : "2024-06-17T19:00:32.000+0000",
    "update_time" : "2024-06-17T19:00:32.000+0000",
    "org_id" : 0,
    "parent_id" : 438086664292,
    "name" : "test-loc",
    "unique_name" : "test-loc",
    "type" : "INDOOR",
    "address" : {
      "address" : "addressLine1",
      "address2" : "addressLine2",
      "city" : "city",
      "state" : "state",
      "postal_code" : "postalCode"
    },
    "country_code" : 840,
    "created_by" : 1,
    "latitude" : 37.23846552983368,
    "longitude" : -121.7852542
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/locations/site?page=1&limit=100&name=Test1&order=ASC' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzMiwiZXhwIjoxNzE5MjU1NjMyfQ.cwEz1D-ttKAnn_E_-UZw-ZynhV7Qls8hwNDM3MARiXA'

Create floor

POST /locations/floor

Request Fields

Path Type Description

name

String

The floor name

parent_id

Number

The parent building ID

environment

String

The RF environment of floor

db_attenuation

Number

The floor attenuation of floor

measurement_unit

String

The measurement unit of floor

installation_height

Number

The installation height of floor

map_size_width

Number

The floor map width

map_size_height

Number

The floor map height

map_name

String

The floor map name

HTTP Request

POST /locations/floor HTTP/1.1
Host: api.extremecloudiq.com
Content-Length: 260
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzMiwiZXhwIjoxNzE5MjU1NjMyfQ.cwEz1D-ttKAnn_E_-UZw-ZynhV7Qls8hwNDM3MARiXA

{
  "parent_id" : 438086664292,
  "name" : "test-floor",
  "environment" : "OFFICE",
  "db_attenuation" : 1.0,
  "measurement_unit" : "METERS",
  "installation_height" : 2.2,
  "map_size_width" : 1000.0,
  "map_size_height" : 980.0,
  "map_name" : "test-map"
}

Response Fields

Path Type Description

id

Number

The floor 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

name

String

The floor name

unique_name

String

The unique name of floor

parent_id

Number

The parent building ID

environment

String

The RF environment of floor

db_attenuation

Number

The floor attenuation of floor

measurement_unit

String

The measurement unit of floor

installation_height

Number

The installation height of floor

map_size_width

Number

The floor map width

map_size_height

Number

The floor map height

map_name

String

The floor map name

HTTP Response

HTTP/1.1 200 OK
RateLimit-Remaining: 7276
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Content-Length: 431

{
  "id" : 438086664193,
  "create_time" : "2024-06-17T19:00:32.000+0000",
  "update_time" : "2024-06-17T19:00:32.000+0000",
  "org_id" : 0,
  "parent_id" : 438086664292,
  "name" : "test-floor",
  "unique_name" : "test-floor",
  "environment" : "OFFICE",
  "db_attenuation" : 1.0,
  "measurement_unit" : "METERS",
  "installation_height" : 2.2,
  "map_size_width" : 1000.0,
  "map_size_height" : 980.0,
  "map_name" : "test-map"
}

cURL Request

$ curl 'https://api.extremecloudiq.com/locations/floor' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzMiwiZXhwIjoxNzE5MjU1NjMyfQ.cwEz1D-ttKAnn_E_-UZw-ZynhV7Qls8hwNDM3MARiXA' \
    -d '{
  "parent_id" : 438086664292,
  "name" : "test-floor",
  "environment" : "OFFICE",
  "db_attenuation" : 1.0,
  "measurement_unit" : "METERS",
  "installation_height" : 2.2,
  "map_size_width" : 1000.0,
  "map_size_height" : 980.0,
  "map_name" : "test-map"
}'

Update floor

PUT /locations/floor/{id}

Path Parameters

Table 16. /locations/floor/{id}
Parameter Description

id

The floor ID

Request Fields

Path Type Description

name

String

The floor name

parent_id

Number

The parent building ID

environment

String

The RF environment of floor

db_attenuation

Number

The floor attenuation of floor

measurement_unit

String

The measurement unit of floor

installation_height

Number

The installation height of floor

map_size_width

Number

The floor map width

map_size_height

Number

The floor map height

map_name

String

The floor map name

HTTP Request

PUT /locations/floor/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Content-Length: 260
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzMywiZXhwIjoxNzE5MjU1NjMzfQ.5uMeyvoxZU2Wh3VxtwDwFmHz0r0Yc-KS7Sy7jfbiCnA

{
  "parent_id" : 438086664292,
  "name" : "test-floor",
  "environment" : "OFFICE",
  "db_attenuation" : 1.0,
  "measurement_unit" : "METERS",
  "installation_height" : 2.2,
  "map_size_width" : 1000.0,
  "map_size_height" : 980.0,
  "map_name" : "test-map"
}

Response Fields

Path Type Description

id

Number

The floor 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

name

String

The floor name

unique_name

String

The unique name of floor

parent_id

Number

The parent building ID

environment

String

The RF environment of floor

db_attenuation

Number

The floor attenuation of floor

measurement_unit

String

The measurement unit of floor

installation_height

Number

The installation height of floor

map_size_width

Number

The floor map width

map_size_height

Number

The floor map height

map_name

String

The floor map name

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
RateLimit-Remaining: 7270
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Content-Length: 431

{
  "id" : 438086664193,
  "create_time" : "2024-06-17T19:00:33.000+0000",
  "update_time" : "2024-06-17T19:00:33.000+0000",
  "org_id" : 0,
  "parent_id" : 438086664292,
  "name" : "test-floor",
  "unique_name" : "test-floor",
  "environment" : "OFFICE",
  "db_attenuation" : 1.0,
  "measurement_unit" : "METERS",
  "installation_height" : 2.2,
  "map_size_width" : 1000.0,
  "map_size_height" : 980.0,
  "map_name" : "test-map"
}

cURL Request

$ curl 'https://api.extremecloudiq.com/locations/floor/438086664193' -i -X PUT \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzMywiZXhwIjoxNzE5MjU1NjMzfQ.5uMeyvoxZU2Wh3VxtwDwFmHz0r0Yc-KS7Sy7jfbiCnA' \
    -d '{
  "parent_id" : 438086664292,
  "name" : "test-floor",
  "environment" : "OFFICE",
  "db_attenuation" : 1.0,
  "measurement_unit" : "METERS",
  "installation_height" : 2.2,
  "map_size_width" : 1000.0,
  "map_size_height" : 980.0,
  "map_name" : "test-map"
}'

Delete floor

DELETE /locations/floor/{id}

Path Parameters

Table 17. /locations/floor/{id}
Parameter Description

id

The floor ID

HTTP Request

DELETE /locations/floor/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzMywiZXhwIjoxNzE5MjU1NjMzfQ.5uMeyvoxZU2Wh3VxtwDwFmHz0r0Yc-KS7Sy7jfbiCnA

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
RateLimit-Remaining: 7272

cURL Request

$ curl 'https://api.extremecloudiq.com/locations/floor/438086664193' -i -X DELETE \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzMywiZXhwIjoxNzE5MjU1NjMzfQ.5uMeyvoxZU2Wh3VxtwDwFmHz0r0Yc-KS7Sy7jfbiCnA'

List floors

GET /locations/floor

Request parameters

Parameter Description

page

Page number

limit

Page size

name

order

The sort order by name (ascending by default)

HTTP Request

GET /locations/floor?page=1&limit=100&name=Test1&order=ASC HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzMSwiZXhwIjoxNzE5MjU1NjMxfQ.ej9a9ZoeOfnIzf-2e0wKqJSQMpeDEuh22CPa0cQb_58
Host: api.extremecloudiq.com
Content-Type: application/json

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 floor 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[].name

String

The floor name

data[].unique_name

String

The unique name of floor

data[].parent_id

Number

The parent building ID

data[].environment

String

The RF environment of floor

data[].db_attenuation

Number

The floor attenuation of floor

data[].measurement_unit

String

The measurement unit of floor

data[].installation_height

Number

The installation height of floor

data[].map_size_width

Number

The floor map width

data[].map_size_height

Number

The floor map height

data[].map_name

String

The floor map name

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
RateLimit-Remaining: 7279
Expires: 0
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Content-Length: 551

{
  "page" : 1,
  "count" : 0,
  "total_pages" : 0,
  "total_count" : 0,
  "data" : [ {
    "id" : 438086664193,
    "create_time" : "2024-06-17T19:00:31.000+0000",
    "update_time" : "2024-06-17T19:00:31.000+0000",
    "org_id" : 0,
    "parent_id" : 438086664292,
    "name" : "test-floor",
    "unique_name" : "test-floor",
    "environment" : "OFFICE",
    "db_attenuation" : 1.0,
    "measurement_unit" : "METERS",
    "installation_height" : 2.2,
    "map_size_width" : 1000.0,
    "map_size_height" : 980.0,
    "map_name" : "test-map"
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/locations/floor?page=1&limit=100&name=Test1&order=ASC' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzMSwiZXhwIjoxNzE5MjU1NjMxfQ.ej9a9ZoeOfnIzf-2e0wKqJSQMpeDEuh22CPa0cQb_58' \
    -H 'Content-Type: application/json'

Upload floor plan

POST /locations/floorplan

HTTP Request

POST /locations/floorplan HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzMSwiZXhwIjoxNzE5MjU1NjMxfQ.ej9a9ZoeOfnIzf-2e0wKqJSQMpeDEuh22CPa0cQb_58
Host: api.extremecloudiq.com
Content-Type: multipart/form-data; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Type: application/json; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm

--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=file; filename=image.png
Content-Type: images/png

data
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
RateLimit-Remaining: 7279
Expires: 0
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

cURL Request

$ curl 'https://api.extremecloudiq.com/locations/floorplan' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzMSwiZXhwIjoxNzE5MjU1NjMxfQ.ej9a9ZoeOfnIzf-2e0wKqJSQMpeDEuh22CPa0cQb_58' \
    -H 'Content-Type: multipart/form-data' \
    -H 'Content-Type: application/json' \
    -F 'file=@image.png;type=images/png'

Start Ekahau import

POST /locations/import/ekahau

HTTP Request

POST /locations/import/ekahau HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: multipart/form-data; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Type: multipart/form-data; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzMywiZXhwIjoxNzE5MjU1NjMzfQ.5uMeyvoxZU2Wh3VxtwDwFmHz0r0Yc-KS7Sy7jfbiCnA

--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=async

false
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=associations

{"1st floor":1}
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=importCustomApConfigurations

true
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=file; filename=ekahau.esx
Content-Type: application/octet-stream

data
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--

Request Parameters

Parameter Description

async

Whether running this request as async or not.

associations

Describes how imported floors are associated with buildings.

importCustomApConfigurations

Whether to also import or not the custom AP configurations such as: Hostname, TX Power & Channel.

Request Parts

Part Description

file

The Ekahau archive to import floors from.

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
Content-Length: 1715
RateLimit-Limit: 7500;w=3600
RateLimit-Remaining: 7267
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "results" : [ {
    "name" : "1st floor",
    "status" : "FAILURE",
    "issues" : {
      "floor" : {
        "error_code" : "ekahau.import.floor.not.found.in.input.file",
        "error_message" : "Floor with name '1st floor' could not be found in the input file.",
        "error_parameters" : {
          "name" : "1st floor"
        }
      },
      "background" : {
        "error_code" : "ekahau.import.background.not.found.in.input.file",
        "error_message" : "Background image with id 589fa276-e65d-485b-8de6-6047c3709d81 could not be found in the input file.",
        "error_parameters" : {
          "backgroundId" : "589fa276-e65d-485b-8de6-6047c3709d81"
        }
      },
      "custom_ap_configurations" : {
        "41f3c275-d63f-4ef2-a253-f821b1f94965" : [ {
          "error_code" : "ekahau.import.ap.name.invalid.as.a.hostname",
          "error_message" : "'an invalid hostname' can not be used as a hostname.",
          "error_parameters" : {
            "name" : "an invalid hostname"
          }
        } ]
      },
      "discarded_aps" : {
        "b0469a67-551c-40fc-ace6-0ad9ae3927ae" : {
          "error_code" : "ekahau.import.ap.is.not.a.real.device",
          "error_message" : "AP exists on the system but it is a 'SIMULATED' device.",
          "error_parameters" : {
            "deviceType" : "SIMULATED"
          }
        }
      },
      "discarded_walls" : {
        "1c2fd114-ccf2-4408-a392-1f081ea222c5" : {
          "error_code" : "ekahau.import.wall.with.unsupported.type",
          "error_message" : "Wall type 'CARDBOARD' is not supported",
          "error_parameters" : {
            "wallType" : "CARDBOARD"
          }
        }
      }
    }
  } ]
}

Response Fields

Path Type Description

results[].name

String

Name of the imported floor.

results[].status

String

Resulting status of the floor import.

results[].issues.floor.error_code

String

Error code identifying this issue.

results[].issues.floor.error_message

String

Error message describing this issue.

results[].issues.floor.error_parameters.*

String

Parameter name → Parameter value.

results[].issues.background.error_code

String

Error code identifying this issue.

results[].issues.background.error_message

String

Error message describing this issue.

results[].issues.background.error_parameters.*

String

Parameter name → Parameter value.

results[].issues.custom_ap_configurations.*.[].error_code

String

Error code identifying this issue.

results[].issues.custom_ap_configurations.*.[].error_message

String

Error message describing this issue.

results[].issues.custom_ap_configurations.*.[].error_parameters.*

String

Parameter name → Parameter value.

results[].issues.discarded_aps.*.error_code

String

Error code identifying this issue.

results[].issues.discarded_aps.*.error_message

String

Error message describing this issue.

results[].issues.discarded_aps.*.error_parameters.*

String

Parameter name → Parameter value.

results[].issues.discarded_walls.*.error_code

String

Error code identifying this issue.

results[].issues.discarded_walls.*.error_message

String

Error message describing this issue.

results[].issues.discarded_walls.*.error_parameters.*

String

Parameter name → Parameter value.

cURL Request

$ curl 'https://api.extremecloudiq.com/locations/import/ekahau' -i -X POST \
    -H 'Content-Type: multipart/form-data' \
    -H 'Content-Type: multipart/form-data' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzMywiZXhwIjoxNzE5MjU1NjMzfQ.5uMeyvoxZU2Wh3VxtwDwFmHz0r0Yc-KS7Sy7jfbiCnA' \
    -F 'file=@ekahau.esx;type=application/octet-stream' \
    -F 'async=false' \
    -F 'associations={"1st floor":1}' \
    -F 'importCustomApConfigurations=true'

Start Ekahau import

POST /locations/import/ekahau

HTTP Request

POST /locations/import/ekahau HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: multipart/form-data; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Type: multipart/form-data; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzMywiZXhwIjoxNzE5MjU1NjMzfQ.5uMeyvoxZU2Wh3VxtwDwFmHz0r0Yc-KS7Sy7jfbiCnA

--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=async

true
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=associations

{"1st floor":1}
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=importCustomApConfigurations

true
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=file; filename=ekahau.esx
Content-Type: application/octet-stream

data
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--

Request Parameters

Parameter Description

async

Whether running this request as async or not.

associations

Describes how imported floors are associated with buildings.

importCustomApConfigurations

Whether to also import or not the custom AP configurations such as: Hostname, TX Power & Channel.

Request Parts

Part Description

file

The Ekahau archive to import floors from.

HTTP Response

HTTP/1.1 202 Accepted
Location: http://localhost:-1/operations/operation-id
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
Retry-After: 2
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
RateLimit-Remaining: 7273

cURL Request

$ curl 'https://api.extremecloudiq.com/locations/import/ekahau' -i -X POST \
    -H 'Content-Type: multipart/form-data' \
    -H 'Content-Type: multipart/form-data' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzMywiZXhwIjoxNzE5MjU1NjMzfQ.5uMeyvoxZU2Wh3VxtwDwFmHz0r0Yc-KS7Sy7jfbiCnA' \
    -F 'file=@ekahau.esx;type=application/octet-stream' \
    -F 'async=true' \
    -F 'associations={"1st floor":1}' \
    -F 'importCustomApConfigurations=true'

Get location tree

GET /locations/tree

Request Parameters

Parameter Description

parentId

The parent location ID, return root locations if parent is null

expandChildren

Whether to return the child locations recursively, default is true.\n"
"Set it to false to improve performance when there are a lot of child locations.

HTTP Request

GET /locations/tree?parentId=438086664292&expandChildren=true HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzMywiZXhwIjoxNzE5MjU1NjMzfQ.5uMeyvoxZU2Wh3VxtwDwFmHz0r0Yc-KS7Sy7jfbiCnA

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.

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
Content-Length: 1045
RateLimit-Remaining: 7269
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

[ {
  "id" : 438086664193,
  "create_time" : "2024-06-17T19:00:33.000+0000",
  "update_time" : "2024-06-17T19:00:33.000+0000",
  "org_id" : 0,
  "parent_id" : 438086664292,
  "name" : "Extreme",
  "unique_name" : "Extreme",
  "type" : "",
  "address" : "addressLine1, addressLine2, city, state, postalCode",
  "children" : [ {
    "id" : 438086664192,
    "create_time" : "2024-06-17T19:00:33.000+0000",
    "update_time" : "2024-06-17T19:00:33.000+0000",
    "org_id" : 0,
    "parent_id" : 438086664292,
    "name" : "Extreme_000",
    "unique_name" : "Extreme_000",
    "type" : "",
    "address" : "addressLine1, addressLine2, city, state, postalCode",
    "children" : [ ]
  }, {
    "id" : 438086664193,
    "create_time" : "2024-06-17T19:00:33.000+0000",
    "update_time" : "2024-06-17T19:00:33.000+0000",
    "org_id" : 0,
    "parent_id" : 438086664292,
    "name" : "Extreme_001",
    "unique_name" : "Extreme_001",
    "type" : "",
    "address" : "addressLine1, addressLine2, city, state, postalCode",
    "children" : [ ]
  } ]
} ]

cURL Request

$ curl 'https://api.extremecloudiq.com/locations/tree?parentId=438086664292&expandChildren=true' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgzMywiZXhwIjoxNzE5MjU1NjMzfQ.5uMeyvoxZU2Wh3VxtwDwFmHz0r0Yc-KS7Sy7jfbiCnA'

Device

List devices

GET /devices

Request Parameters

Parameter Description

page

Page number

limit

Page size

locationId

Location id

connected

The device connect status

adminStates

The device admin manage status

macAddresses

The device mac addresses

sns

The device serial numbers

hostnames

The device hostnames

sortField

The device sort field

order

The device sort order

views

A view is a collection of device fields.
Currently supported views are basic, detail, status, client, location, full.
[Basic View]: id, org_id, serial_number, service_tag, mac_address, simulated, device_function, product_type, hostname, ip_address, software_version, managed_by, device_admin_state, connected, description, country_code, system_up_time
[Detail View]: id, org_id, create_time, update_time, serial_number, service_tag, mac_address, simulated, device_function, product_type, hostname, ip_address, software_version, managed_by, device_admin_state, connected, last_connect_time, dns_server_address, subnet_mask, default_gateway, ipv6_address, ipv6_netmask, display_version, system_up_time
[Status View]: id, device_admin_state, connected, description
[Client View]: id, active_clients
[Location View]: id, location_id, locations.

fields

The device fields to return.
[All available fields]: id, create_time, update_time, org_id, org_name, location_id, serial_number, mac_address, device_function, product_type, hostname, ip_address, software_version, device_admin_state, connected, last_connect_time, network_policy_name, network_policy_id, ntp_server_address, dns_server_address, subnet_mask, default_gateway, ipv6_address, ipv6_netmask, simulated, display_version, active_clients, locations, description, country_code, lldp_cdp_info, system_up_time

deviceTypes

The device types

nullField

The device empty field to filter. Only return the devices with the selected fields which are null

locationIds

The location IDs

configMismatch

Config audit status(MATCHED or UNMATCHED)

thread0_eui64

Thread router EUI64

thread0_ext_mac

Thread router extended MAC address

HTTP Request

GET /devices?page=1&limit=10&locationId=438086664193&connected=false&adminStates=MANAGED%2CNEW&fields=HOSTNAME%2CACTIVE_CLIENTS&deviceTypes=REAL%2CDIGITAL_TWIN&nullField=LOCATION_ID HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgyMiwiZXhwIjoxNzE5MjU1NjIyfQ.LxaCJGR3QQizwMs7fwviS81KDDjQOa_qksA7OK0lt9Q

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

data[].network_policy_name

String

The device network policy name

data[].network_policy_id

Number

The device network policy ID

data[].primary_ntp_server_address

String

The primary NTP server address of the device

data[].primary_dns_server_address

String

The primary DNS server address of the device

data[].subnet_mask

String

The subnet mask of the device

data[].default_gateway

String

The default gateway of device

data[].ipv6_address

String

The ipv6 address of the device

data[].ipv6_netmask

Number

The ipv6 netmask of the device

data[].simulated

Boolean

Device is simulated or not

data[].display_version

String

The device display version

data[].active_clients

Number

The active clients for the device

data[].location_id

Number

The device location ID

data[].locations

Array

The device detailed location

data[].lldp_cdp_infos

Array

The device LLDP/CDP information

data[].country_code

Number

The assigned country code for the device

data[].description

String

The device description

data[].system_up_time

Number

The system up time for the device

data[].config_mismatch

Boolean

Config audit status(MATCHED or UNMATCHED)

data[].managed_by

String

The managed application for device)

data[].thread0_eui64

String

Thread router EUI64

data[].thread0_ext_mac

String

Thread router extended MAC address

HTTP Response

HTTP/1.1 200 OK
RateLimit-Remaining: 7275
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Length: 2363
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 2,
  "total_count" : 15,
  "data" : [ {
    "id" : 1,
    "create_time" : "2024-06-17T19:00:22.000+0000",
    "update_time" : "2024-06-17T19:00:22.000+0000",
    "org_id" : 10,
    "serial_number" : "85438262144350",
    "service_tag" : "",
    "mac_address" : "x2c2p0BHGOq5",
    "device_function" : "AP",
    "product_type" : "AP_230",
    "hostname" : "PLAN-6216E1-1",
    "ip_address" : "192.168.56.1",
    "software_version" : "8.4.10.0",
    "device_admin_state" : "MANAGED",
    "connected" : true,
    "last_connect_time" : "2024-06-17T19:00:22.000+0000",
    "network_policy_name" : "test-nwp",
    "network_policy_id" : 1,
    "primary_ntp_server_address" : "",
    "primary_dns_server_address" : "",
    "subnet_mask" : "",
    "default_gateway" : "",
    "ipv6_address" : "",
    "ipv6_netmask" : 0,
    "simulated" : false,
    "display_version" : "",
    "active_clients" : 0,
    "location_id" : 0,
    "locations" : [ ],
    "country_code" : 840,
    "description" : "Device description",
    "lldp_cdp_infos" : [ ],
    "system_up_time" : 0,
    "config_mismatch" : true,
    "managed_by" : "XIQ",
    "thread0_eui64" : "",
    "thread0_ext_mac" : ""
  }, {
    "id" : 2,
    "create_time" : "2024-06-17T19:00:22.000+0000",
    "update_time" : "2024-06-17T19:00:22.000+0000",
    "org_id" : 10,
    "serial_number" : "64028964476923",
    "service_tag" : "",
    "mac_address" : "vS67H21u08V9",
    "device_function" : "SWITCH",
    "product_type" : "SwitchEngine_5320_16P_4XE",
    "hostname" : "5-1-ESEV",
    "ip_address" : "",
    "software_version" : "32.1.0.369",
    "device_admin_state" : "NEW",
    "connected" : true,
    "last_connect_time" : "2024-06-17T19:00:22.000+0000",
    "network_policy_name" : "test-nwp",
    "network_policy_id" : 1,
    "primary_ntp_server_address" : "",
    "primary_dns_server_address" : "",
    "subnet_mask" : "",
    "default_gateway" : "",
    "ipv6_address" : "",
    "ipv6_netmask" : 0,
    "simulated" : false,
    "display_version" : "",
    "active_clients" : 0,
    "location_id" : 0,
    "locations" : [ ],
    "country_code" : 840,
    "description" : "Device description",
    "lldp_cdp_infos" : [ ],
    "system_up_time" : 0,
    "config_mismatch" : true,
    "managed_by" : "SE",
    "thread0_eui64" : "",
    "thread0_ext_mac" : ""
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/devices?page=1&limit=10&locationId=438086664193&connected=false&adminStates=MANAGED%2CNEW&fields=HOSTNAME%2CACTIVE_CLIENTS&deviceTypes=REAL%2CDIGITAL_TWIN&nullField=LOCATION_ID' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgyMiwiZXhwIjoxNzE5MjU1NjIyfQ.LxaCJGR3QQizwMs7fwviS81KDDjQOa_qksA7OK0lt9Q'

List Digital Twin Products

GET /devices/digital-twin

Request Parameters

Parameter Description

page

Page number

limit

Page size

makes

List by makes or null/empty to list by any makes

models

List by makes or null/empty to list by any makes

HTTP Request

GET /devices/digital-twin?page=1&limit=100&makes=SWITCH_ENGINE&makes=FABRIC_ENGINE&models=DT_5320_16P_4XE HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgxOSwiZXhwIjoxNzE5MjU1NjE5fQ.bC2mSP0Clm4nuHOh5N4SEsqBRdSfzcZKX-SlNB5OUFM
Content-Type: application/json

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[].make

String

The Digital Twin device make.

data[].model

String

The Digital Twin device model.

data[].os_type

String

The OS Type of the Digital Twin device.

data[].os_versions

Array

The supported OS versions of the Digital Twin device.

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
RateLimit-Remaining: 7317
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Content-Length: 400

{
  "page" : 2,
  "count" : 100,
  "total_pages" : 1,
  "total_count" : 2,
  "data" : [ {
    "make" : "SwitchEngine",
    "model" : "5320-16P-4XE",
    "os_type" : "",
    "os_versions" : [ "32.1.1.6", "32.2.1.8", "32.3.1.11" ]
  }, {
    "make" : "FabricEngine",
    "model" : "5320-16P-4XE",
    "os_type" : "",
    "os_versions" : [ "8.7.0.0", "8.7.0.1", "8.8.0.0", "8.8.1.0", "8.9.0.0" ]
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/digital-twin?page=1&limit=100&makes=SWITCH_ENGINE&makes=FABRIC_ENGINE&models=DT_5320_16P_4XE' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgxOSwiZXhwIjoxNzE5MjU1NjE5fQ.bC2mSP0Clm4nuHOh5N4SEsqBRdSfzcZKX-SlNB5OUFM' \
    -H 'Content-Type: application/json'

Get device iBeacon

GET /devices/{id}/ibeacon

Path Parameters

Table 18. /devices/{id}/ibeacon
Parameter Description

id

Device ID

HTTP Request

GET /devices/438086664193/ibeacon HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgyMSwiZXhwIjoxNzE5MjU1NjIxfQ.UaAA_A_YY3f8svF37fLEZn-QWSPMIq6omz25BDXCH2A
Content-Type: application/json

Response Fields

Path Type Description

enabled

Boolean

Whether to enable the device beacon

device_id

Number

The device ID

major

Number

Identification of a subset of beacons in a venue.

minor

Number

Identification of a beacon in a specific location.

power

Number

The transmission power in dBm.

enable_monitoring

Boolean

Whether to enable monitoring

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Remaining: 7288
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Length: 129
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "device_id" : 438086664193,
  "enabled" : true,
  "major" : 1,
  "minor" : 1,
  "power" : -59,
  "enable_monitoring" : true
}

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/438086664193/ibeacon' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgyMSwiZXhwIjoxNzE5MjU1NjIxfQ.UaAA_A_YY3f8svF37fLEZn-QWSPMIq6omz25BDXCH2A' \
    -H 'Content-Type: application/json'

Update device-level iBeacon settings

PUT /devices/ibeacon

HTTP Request

PUT /devices/ibeacon HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgyMywiZXhwIjoxNzE5MjU1NjIzfQ.Zp-AXXycmo0oB41I9CZ6xfp7L1Uybex1K820E56RKko
Content-Type: application/json
Content-Length: 134

{
  "device_ids" : [ 438086664193 ],
  "enabled" : true,
  "major" : 1,
  "minor" : 1,
  "power" : -59,
  "enable_monitoring" : true
}

Request Fields

Path Type Description

device_ids

Array

The list of device IDs to update the device level iBeacon settings.

enabled

Boolean

Whether to enable the device beacon

major

Number

Identification of a subset of beacons in a venue.

minor

Number

Identification of a beacon in a specific location.

power

Number

The transmission power in dBm.

enable_monitoring

Boolean

Whether to enable monitoring

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
RateLimit-Remaining: 7268
Expires: 0
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/ibeacon' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgyMywiZXhwIjoxNzE5MjU1NjIzfQ.Zp-AXXycmo0oB41I9CZ6xfp7L1Uybex1K820E56RKko' \
    -H 'Content-Type: application/json' \
    -d '{
  "device_ids" : [ 438086664193 ],
  "enabled" : true,
  "major" : 1,
  "minor" : 1,
  "power" : -59,
  "enable_monitoring" : true
}'

Get Single Thread Gateway IoT profile

GET /devices/{id}/iot

Path Parameters

Table 19. /devices/{id}/iot
Parameter Description

id

Device ID

HTTP Request

GET /devices/438086664193/iot HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgyMCwiZXhwIjoxNzE5MjU1NjIwfQ.tC5no9q6HT9_oNdAoYUUasc7xFeedWGphVi_Nyx2Px8
Content-Type: application/json

Response Fields

Path Type Description

enabled

Boolean

Whether IoT Interface Settings is enabled on AP device.

iot_profile.id

Number

The iot profile ID.

iot_profile.name

String

The iot profile name.

iot_profile.create_time

String

The create time of the iot profile.

iot_profile.update_time

String

The update time of the iot profile.

iot_profile.app_id

String

The iot application type. Currently, only THREAD_GATEWAY is supported.

iot_profile.app_supported

String

The IoT profile App Supported type. For Single such as Thread Gateway, the app supported type is SINGLE. For Multi-Application IoT profiles, the app supported type is MULTI.

iot_profile.thread_gateway

Object

When app_id = THREAD_GATEWAY provides definition of thread gateway.

iot_profile.thread_gateway.short_pan_id

String

The Personal Area Network (PAN) ID. (4 hex digits). FFFF is reserved.

iot_profile.thread_gateway.ext_pan_id

String

The Extended Personal Area Network (PAN) ID. (16 hex digits)

iot_profile.thread_gateway.master_key

String

The network key is used to secure access to the Thread network. It is used to encrypt and authenticate all messages on the network. (32 hex digits)

iot_profile.thread_gateway.network_name

String

A human-readable name for the network, up to 16 bytes in length

iot_profile.thread_gateway.channel

Number

802.15.4 channel number, 11-26

iot_profile.thread_gateway.comm_credentials

String

The Commissioner Credential is used along with the Extended PAN ID, and Network Name to create the PSKc (Pre-Shared Key for the Commissioner).

iot_profile.thread_gateway.comm_timeout

Number

After this timeout the Commissioner will shutdown. The default is 120 sec. but the max is approximately 23 days.

iot_profile.thread_gateway.enable_nat64

Boolean

Enable NAT64 functions including the translator and the prefix publishing.

iot_profile.thread_gateway.white_list

Array

The table of approved Thread end-devices.

iot_profile.thread_gateway.white_list[].long_eui

String

The factory-assigned IEEE EUI-64. (16 hex digits). FFFFFFFFFFFFFFFF is reserved. Use * to match any joiner.

iot_profile.thread_gateway.white_list[].pskd

String

The PSKd (Pre-Shared-Key for the Device) is the Joining Device Credential encoded using base32-thread. A Joining Device Credential is encoded as uppercase, alphanumeric characters (base32-thread: 0-9,A-Y excluding I,O,Q, and Z for readability) with a minimum length of 6 such characters and a maximum length of 32 such characters.

iot_profile.thread_gateway.default_user_profile_id

Number

The default user-profile ID.

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Content-Length: 918
Expires: 0
X-Content-Type-Options: nosniff
RateLimit-Remaining: 7308
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "enabled" : true,
  "iot_profile" : {
    "id" : 438086664193,
    "create_time" : "2024-06-17T19:00:20.000+0000",
    "update_time" : "2024-06-17T19:00:20.000+0000",
    "name" : "iot-profile-438086664193",
    "app_id" : "THREAD_GATEWAY",
    "thread_gateway" : {
      "short_pan_id" : "57a6",
      "ext_pan_id" : "bf72c18691d20d21",
      "master_key" : "f6a4f7acde3137d36f0fd80e7d3cb9dc",
      "network_name" : "thread-network-438086664193",
      "channel" : 15,
      "comm_credentials" : "1e3caec3",
      "comm_timeout" : 120,
      "enable_nat64" : true,
      "white_list" : [ {
        "long_eui" : "dd4be80abbe35e30",
        "pskd" : "KFJPA4"
      }, {
        "long_eui" : "769b08bb1d23672b",
        "pskd" : "YY5M36"
      }, {
        "long_eui" : "176bf8aaa60f1a18",
        "pskd" : "VFDH2MF0M6J5B2E"
      } ],
      "default_user_profile_id" : 1
    },
    "app_supported" : "SINGLE"
  }
}

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/438086664193/iot' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgyMCwiZXhwIjoxNzE5MjU1NjIwfQ.tC5no9q6HT9_oNdAoYUUasc7xFeedWGphVi_Nyx2Px8' \
    -H 'Content-Type: application/json'

Get Multi-Application IoT profile

GET /devices/{id}/iot

Path Parameters

Table 20. /devices/{id}/iot
Parameter Description

id

Device ID

HTTP Request

GET /devices/438086664193/iot HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgyMiwiZXhwIjoxNzE5MjU1NjIyfQ.LxaCJGR3QQizwMs7fwviS81KDDjQOa_qksA7OK0lt9Q

Response Fields

Path Type Description

enabled

Boolean

Whether IoT Interface Settings is enabled on AP device.

iot_profile.id

Number

The iot profile ID.

iot_profile.name

String

The iot profile name.

iot_profile.create_time

String

The create time of the iot profile.

iot_profile.update_time

String

The update time of the iot profile.

iot_profile.app_supported

String

The IoT profile App Supported type. For Single such as Thread Gateway, the app supported type is SINGLE. For Multi-Application IoT profiles, the app supported type is MULTI.

iot_profile.ble_beacon

Object

The BLE Beacon settings when app_supported = MULTI provides definition of Multi-Application.

iot_profile.ble_beacon.applications

Array

The BLE Beacon Applications.

iot_profile.ble_beacon.applications[].app_type

String

The BLE Beacon application type.

iot_profile.ble_beacon.applications[].measured_rss

Number

The BLE Beacon application measured Received Signal Strength value, in dBm.

iot_profile.ble_beacon.applications[].advertise_interval

Number

The BLE Beacon application advertise interval value in ms.

iot_profile.ble_beacon.applications[].tx_power

Number

The BLE Beacon transmit power, in dBm.

iot_profile.ble_beacon.applications[].major

Number

The BLE iBeacon application major value, for BLE Beacon applications of type IBEACON.

iot_profile.ble_beacon.applications[].minor

Number

The BLE Beacon iBeacon application minor value, for BLE Beacon applications of type IBEACON.

iot_profile.ble_beacon.applications[].uuid

String

The BLE Beacon iBeacon application UUID, for BLE Beacon applications of type IBEACON.

iot_profile.ble_beacon.applications[].url

String

he BLE Beacon Eddystone-url application URL, for BLE Beacon applications of type EDDYSTONE_URL.

iot_profile.ble_scan

Object

The BLE Scan settings when app_supported = MULTI provides definition of Multi-Application.

iot_profile.ble_scan.destination.http_server.interval

Number

The BLE Scan destination HTTP server interval, in seconds.

iot_profile.ble_scan.destination.http_server.url

String

The BLE Scan destination HTTP server URL.

iot_profile.ble_scan.applications

Array

The BLE Scan Applications.

iot_profile.ble_scan.applications[].app_type

String

The BLE Scan application type.

iot_profile.ble_scan.applications[].min_rss

Number

The BLE Scan application minimum RSS value.

iot_profile.ble_scan.applications[].uuid

String

The BLE Scan application UUID, for BLE Scan applications of type IBEACON.

iot_profile.ble_scan.applications[].vendors

Array

The BLE Scan Generic application vendors, for BLE Scan applications of type GENERIC.

iot_profile.ble_scan.applications[].vendors[].vendor_type

String

The BLE Scan Vendor Type.

iot_profile.ble_scan.applications[].vendors[].vendor_name

String

The custom BLE Scan Vendor name, only for CUSTOM vendor type.

iot_profile.ble_scan.applications[].vendors[].company_id

Number

The custom BLE Scan company ID, only for CUSTOM vendor type.

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Length: 1350
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
RateLimit-Remaining: 7274

{
  "enabled" : true,
  "iot_profile" : {
    "id" : 438086664193,
    "create_time" : "2024-06-17T19:00:22.000+0000",
    "update_time" : "2024-06-17T19:00:22.000+0000",
    "name" : "iot-profile-438086664193",
    "app_supported" : "MULTI",
    "ble_beacon" : {
      "applications" : [ {
        "measured_rss" : 50,
        "advertise_interval" : 100,
        "tx_power" : 3,
        "major" : 1000,
        "minor" : 500,
        "uuid" : "88035bdf-d635-4f0e-9636-80d4ee4e99fb",
        "app_type" : "IBEACON"
      }, {
        "measured_rss" : 50,
        "advertise_interval" : 100,
        "tx_power" : 3,
        "url" : "http://www.extremenetworks.com",
        "app_type" : "EDDYSTONE_URL"
      } ]
    },
    "ble_scan" : {
      "destination" : {
        "http_server" : {
          "url" : "http://www.extremenetworks.com",
          "interval" : 100
        }
      },
      "applications" : [ {
        "min_rss" : -10,
        "uuid" : "1d8b11ff-076a-4ca2-a6a4-efaa67820401",
        "app_type" : "IBEACON"
      }, {
        "min_rss" : -10,
        "vendors" : [ ],
        "app_type" : "GENERIC"
      }, {
        "min_rss" : -10,
        "vendors" : [ {
          "vendor_type" : "CUSTOM",
          "vendor_name" : "Company Name",
          "company_id" : 741
        } ],
        "app_type" : "GENERIC"
      } ]
    }
  }
}

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/438086664193/iot' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgyMiwiZXhwIjoxNzE5MjU1NjIyfQ.LxaCJGR3QQizwMs7fwviS81KDDjQOa_qksA7OK0lt9Q'

Enable device IoT

POST /devices/{id}/iot/:enable

Path Parameters

Table 21. /devices/{id}/iot/:enable
Parameter Description

id

Device ID

HTTP Request

POST /devices/438086664193/iot/:enable HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgyMywiZXhwIjoxNzE5MjU1NjIzfQ.Zp-AXXycmo0oB41I9CZ6xfp7L1Uybex1K820E56RKko
Content-Length: 12
Content-Type: application/json
Content-Type: application/json

438086664193

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
RateLimit-Remaining: 7268
Expires: 0
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/438086664193/iot/:enable' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgyMywiZXhwIjoxNzE5MjU1NjIzfQ.Zp-AXXycmo0oB41I9CZ6xfp7L1Uybex1K820E56RKko' \
    -H 'Content-Type: application/json' \
    -H 'Content-Type: application/json' \
    -d '438086664193'

Disable device IoT

POST /devices/{id}/iot/:disable

Path Parameters

Table 22. /devices/{id}/iot/:disable
Parameter Description

id

Device ID

HTTP Request

POST /devices/438086664193/iot/:disable HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgyMywiZXhwIjoxNzE5MjU1NjIzfQ.Zp-AXXycmo0oB41I9CZ6xfp7L1Uybex1K820E56RKko
Content-Type: application/json

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
RateLimit-Remaining: 7267
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/438086664193/iot/:disable' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgyMywiZXhwIjoxNzE5MjU1NjIzfQ.Zp-AXXycmo0oB41I9CZ6xfp7L1Uybex1K820E56RKko' \
    -H 'Content-Type: application/json'

Send CLI

Send CLI to devices.

POST /devices/:cli

Request Fields

Path Type Description

devices.ids

Array

The device ID list.

clis

Array

The CLI list.

HTTP Request

POST /devices/:cli HTTP/1.1
Host: api.extremecloudiq.com
Content-Length: 120
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgyMywiZXhwIjoxNzE5MjU1NjIzfQ.Zp-AXXycmo0oB41I9CZ6xfp7L1Uybex1K820E56RKko
Content-Type: application/json

{
  "devices" : {
    "ids" : [ 438086664193, 438086664194, 438086664195 ]
  },
  "clis" : [ "sh version", "sh mgmt" ]
}

Response Fields

Path Type Description

device_cli_outputs

Object

device ID → CLI outputs

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
Content-Length: 32
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
RateLimit-Remaining: 7270
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "device_cli_outputs" : { }
}

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/:cli' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgyMywiZXhwIjoxNzE5MjU1NjIzfQ.Zp-AXXycmo0oB41I9CZ6xfp7L1Uybex1K820E56RKko' \
    -H 'Content-Type: application/json' \
    -d '{
  "devices" : {
    "ids" : [ 438086664193, 438086664194, 438086664195 ]
  },
  "clis" : [ "sh version", "sh mgmt" ]
}'

Delete devices

Delete devices by the given device ID list.

POST /devices/:delete

Request Fields

Path Type Description

ids[]

Array

The device ID list.

HTTP Request

POST /devices/:delete HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgyMiwiZXhwIjoxNzE5MjU1NjIyfQ.LxaCJGR3QQizwMs7fwviS81KDDjQOa_qksA7OK0lt9Q
Content-Length: 58
Content-Type: application/json
Content-Type: application/json

{
  "ids" : [ 438086664193, 438086664194, 438086664195 ]
}

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
RateLimit-Remaining: 7278
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/:delete' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgyMiwiZXhwIjoxNzE5MjU1NjIyfQ.LxaCJGR3QQizwMs7fwviS81KDDjQOa_qksA7OK0lt9Q' \
    -H 'Content-Type: application/json' \
    -H 'Content-Type: application/json' \
    -d '{
  "ids" : [ 438086664193, 438086664194, 438086664195 ]
}'

Change status to Managed

Change device management status to Managed status.

POST /devices/:manage

Request Fields

{
  "ids" : [ 438086664193, 438086664194, 438086664195 ]
}

HTTP Request

POST /devices/:unmanage HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgxOSwiZXhwIjoxNzE5MjU1NjE5fQ.bC2mSP0Clm4nuHOh5N4SEsqBRdSfzcZKX-SlNB5OUFM
Content-Type: application/json
Content-Length: 58

{
  "ids" : [ 438086664193, 438086664194, 438086664195 ]
}

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
RateLimit-Remaining: 7315
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/:unmanage' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgxOSwiZXhwIjoxNzE5MjU1NjE5fQ.bC2mSP0Clm4nuHOh5N4SEsqBRdSfzcZKX-SlNB5OUFM' \
    -H 'Content-Type: application/json' \
    -d '{
  "ids" : [ 438086664193, 438086664194, 438086664195 ]
}'

Onboard devices

POST /devices/:onboard

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.

dt.dts

Array

The Digital Twin devices to onboard.

HTTP Request

POST /devices/:onboard HTTP/1.1
Host: api.extremecloudiq.com
Content-Length: 450
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgyMiwiZXhwIjoxNzE5MjU1NjIyfQ.LxaCJGR3QQizwMs7fwviS81KDDjQOa_qksA7OK0lt9Q

{
  "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"
    }
  },
  "dt" : {
    "dts" : [ {
      "make" : "FABRIC_ENGINE",
      "model" : "DT_5320_16P_4XE_DC",
      "os_version" : "8.8.1.0"
    } ]
  }
}

HTTP Response

HTTP/1.1 202 Accepted
RateLimit-Remaining: 7275
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/:onboard' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgyMiwiZXhwIjoxNzE5MjU1NjIyfQ.LxaCJGR3QQizwMs7fwviS81KDDjQOa_qksA7OK0lt9Q' \
    -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"
    }
  },
  "dt" : {
    "dts" : [ {
      "make" : "FABRIC_ENGINE",
      "model" : "DT_5320_16P_4XE_DC",
      "os_version" : "8.8.1.0"
    } ]
  }
}'

Advanced onboard devices

POST /devices/:advanced-onboard

HTTP Request

POST /devices/:advanced-onboard?async=false HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgxOSwiZXhwIjoxNzE5MjU1NjE5fQ.bC2mSP0Clm4nuHOh5N4SEsqBRdSfzcZKX-SlNB5OUFM
Content-Type: application/json
Content-Length: 2216

{
  "extreme" : [ {
    "serial_number" : "012238339999",
    "location" : {
      "location_id" : 438086787229,
      "x" : 156.01,
      "y" : 889.81,
      "latitude" : 10.0,
      "longitude" : 23.9
    },
    "network_policy_id" : 438086787230,
    "hostname" : "SanJose-AP1"
  }, {
    "serial_number" : "012238338888",
    "location" : {
      "location_id" : 438086787330,
      "x" : 56.81,
      "y" : 100.81,
      "latitude" : 20.0,
      "longitude" : 33.9
    },
    "network_policy_id" : 438086787123,
    "hostname" : "SanJose-AP2"
  } ],
  "exos" : [ {
    "serial_number" : "JA0ZZZZG-88801",
    "location" : {
      "location_id" : 438086787999,
      "x" : 16.01,
      "y" : 89.81,
      "latitude" : 30.0,
      "longitude" : 43.9
    },
    "network_policy_id" : 438086787230,
    "hostname" : "5420F-48P-4XL-SwitchEngine"
  } ],
  "voss" : [ {
    "serial_number" : "2034G-00113",
    "location" : {
      "location_id" : 438086787339,
      "x" : 153.01,
      "y" : 819.81,
      "latitude" : 102.0,
      "longitude" : 213.9
    },
    "network_policy_id" : 438086787120,
    "hostname" : "5520-48W-FabricEngine"
  } ],
  "wing" : [ {
    "serial_number" : "AAAA-BBBB",
    "mac_address" : "bc:d0:22:11:aa:bb",
    "location" : {
      "location_id" : 438086787539,
      "x" : 34.01,
      "y" : 23.12,
      "latitude" : 202.0,
      "longitude" : 63.9
    },
    "network_policy_id" : 438086787120,
    "hostname" : "WingAP-3321"
  } ],
  "dell" : [ {
    "serial_number" : "XXX-AAAAA",
    "service_tag" : "TAG-AC001",
    "location" : {
      "location_id" : 438086787555,
      "x" : 341.01,
      "y" : 232.12,
      "latitude" : 112.0,
      "longitude" : 632.9
    },
    "network_policy_id" : 438086787121,
    "hostname" : "DellSwitch-8818"
  } ],
  "dt" : [ {
    "digital_twin_device" : {
      "make" : "FABRIC_ENGINE",
      "model" : "DT_5320_16P_4XE_DC",
      "os_type" : "DT-OS-TYPE",
      "os_version" : "8.8.1.0"
    },
    "location" : {
      "location_id" : 438086787555,
      "x" : 34.01,
      "y" : 23.12,
      "latitude" : 12.0,
      "longitude" : 672.9
    },
    "network_policy_id" : 438086787222,
    "hostname" : "DT-NAME"
  } ],
  "unmanaged" : true
}

Request Parameters

Parameter Description

async

Whether running this request as async or not

Request Fields

Path Type Description

extreme[].serial_number

String

The serial number of Extreme/Aerohive device.

extreme[].location.location_id

Number

The assigned location ID, it must be FLOOR type.

extreme[].location.x

Number

The horizontal value in the floor map.

extreme[].location.y

Number

The vertical value in the floor map.

extreme[].location.latitude

Number

The latitude in the geography.

extreme[].location.longitude

Number

The longitude in the geography.

extreme[].network_policy_id

Number

The assigned network policy id.

extreme[].hostname

String

The assigned device hostname.

exos[].serial_number

String

The serial number of ExtremeXOS (EXOS) device.

exos[].location.location_id

Number

The assigned location ID, it must be FLOOR type.

exos[].location.x

Number

The horizontal value in the floor map.

exos[].location.y

Number

The vertical value in the floor map.

exos[].location.latitude

Number

The latitude in the geography.

exos[].location.longitude

Number

The longitude in the geography.

exos[].network_policy_id

Number

The assigned network policy id.

exos[].hostname

String

The assigned device hostname.

voss[].serial_number

String

The serial number of VSP Operating System Software (VOSS) device.

voss[].location.location_id

Number

The assigned location ID, it must be FLOOR type.

voss[].location.x

Number

The horizontal value in the floor map.

voss[].location.y

Number

The vertical value in the floor map.

voss[].location.latitude

Number

The latitude in the geography.

voss[].location.longitude

Number

The longitude in the geography.

voss[].network_policy_id

Number

The assigned network policy id.

voss[].hostname

String

The assigned device hostname.

wing[].serial_number

String

The serial number of ExtremeWireless (WiNG) device.

wing[].mac_address

String

The mac address of ExtremeWireless (WiNG) device.

wing[].location.location_id

Number

The assigned location ID, it must be FLOOR type.

wing[].location.x

Number

The horizontal value in the floor map.

wing[].location.y

Number

The vertical value in the floor map.

wing[].location.latitude

Number

The latitude in the geography.

wing[].location.longitude

Number

The longitude in the geography.

wing[].network_policy_id

Number

The assigned network policy id.

wing[].hostname

String

The assigned device hostname.

dell[].serial_number

String

The serial number of Dell device.

dell[].service_tag

String

The service tag of Dell device.

dell[].location.location_id

Number

The assigned location ID, it must be FLOOR type.

dell[].location.x

Number

The horizontal value in the floor map.

dell[].location.y

Number

The vertical value in the floor map.

dell[].location.latitude

Number

The latitude in the geography.

dell[].location.longitude

Number

The longitude in the geography.

dell[].network_policy_id

Number

The assigned network policy id.

dell[].hostname

String

The assigned device hostname.

dt[].digital_twin_device.make

String

The Digital Twin device make.

dt[].digital_twin_device.model

String

The Digital Twin device model.

dt[].digital_twin_device.os_type

String

The OS Type of the Digital Twin device.

dt[].digital_twin_device.os_version

String

The supported OS versions of the Digital Twin device.

dt[].location.location_id

Number

The assigned location ID, it must be FLOOR type.

dt[].location.x

Number

The horizontal value in the floor map.

dt[].location.y

Number

The vertical value in the floor map.

dt[].location.latitude

Number

The latitude in the geography.

dt[].location.longitude

Number

The longitude in the geography.

dt[].network_policy_id

Number

The assigned network policy id.

dt[].hostname

String

The assigned device hostname.

unmanaged

Boolean

Whether to unmanage the devices.

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
RateLimit-Remaining: 7313
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Content-Length: 354

{
  "success_devices" : [ {
    "serial_number" : "CCC-DDD-EEE",
    "device_id" : 4312147265229
  }, {
    "serial_number" : "AAA-BBB-CCC",
    "device_id" : 4312147265230
  } ],
  "failure_devices" : [ {
    "serial_number" : "EEE-FFF-GGG",
    "error" : "DEVICE_EXISTED"
  }, {
    "serial_number" : "EEE-FFF-KKK",
    "error" : "FAILED_IN_DB"
  } ]
}

Response Fields

Path Type Description

success_devices[].serial_number

String

The serial number of success device.

success_devices[].device_id

Number

The id of device.

failure_devices[].serial_number

String

The serial number of failure device.

failure_devices[].error

String

The onboard error code

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/:advanced-onboard?async=false' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgxOSwiZXhwIjoxNzE5MjU1NjE5fQ.bC2mSP0Clm4nuHOh5N4SEsqBRdSfzcZKX-SlNB5OUFM' \
    -H 'Content-Type: application/json' \
    -d '{
  "extreme" : [ {
    "serial_number" : "012238339999",
    "location" : {
      "location_id" : 438086787229,
      "x" : 156.01,
      "y" : 889.81,
      "latitude" : 10.0,
      "longitude" : 23.9
    },
    "network_policy_id" : 438086787230,
    "hostname" : "SanJose-AP1"
  }, {
    "serial_number" : "012238338888",
    "location" : {
      "location_id" : 438086787330,
      "x" : 56.81,
      "y" : 100.81,
      "latitude" : 20.0,
      "longitude" : 33.9
    },
    "network_policy_id" : 438086787123,
    "hostname" : "SanJose-AP2"
  } ],
  "exos" : [ {
    "serial_number" : "JA0ZZZZG-88801",
    "location" : {
      "location_id" : 438086787999,
      "x" : 16.01,
      "y" : 89.81,
      "latitude" : 30.0,
      "longitude" : 43.9
    },
    "network_policy_id" : 438086787230,
    "hostname" : "5420F-48P-4XL-SwitchEngine"
  } ],
  "voss" : [ {
    "serial_number" : "2034G-00113",
    "location" : {
      "location_id" : 438086787339,
      "x" : 153.01,
      "y" : 819.81,
      "latitude" : 102.0,
      "longitude" : 213.9
    },
    "network_policy_id" : 438086787120,
    "hostname" : "5520-48W-FabricEngine"
  } ],
  "wing" : [ {
    "serial_number" : "AAAA-BBBB",
    "mac_address" : "bc:d0:22:11:aa:bb",
    "location" : {
      "location_id" : 438086787539,
      "x" : 34.01,
      "y" : 23.12,
      "latitude" : 202.0,
      "longitude" : 63.9
    },
    "network_policy_id" : 438086787120,
    "hostname" : "WingAP-3321"
  } ],
  "dell" : [ {
    "serial_number" : "XXX-AAAAA",
    "service_tag" : "TAG-AC001",
    "location" : {
      "location_id" : 438086787555,
      "x" : 341.01,
      "y" : 232.12,
      "latitude" : 112.0,
      "longitude" : 632.9
    },
    "network_policy_id" : 438086787121,
    "hostname" : "DellSwitch-8818"
  } ],
  "dt" : [ {
    "digital_twin_device" : {
      "make" : "FABRIC_ENGINE",
      "model" : "DT_5320_16P_4XE_DC",
      "os_type" : "DT-OS-TYPE",
      "os_version" : "8.8.1.0"
    },
    "location" : {
      "location_id" : 438086787555,
      "x" : 34.01,
      "y" : 23.12,
      "latitude" : 12.0,
      "longitude" : 672.9
    },
    "network_policy_id" : 438086787222,
    "hostname" : "DT-NAME"
  } ],
  "unmanaged" : true
}'

Advanced onboard devices asynchronously

POST /devices/:advanced-onboard

HTTP Request

POST /devices/:advanced-onboard?async=true HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgyMiwiZXhwIjoxNzE5MjU1NjIyfQ.LxaCJGR3QQizwMs7fwviS81KDDjQOa_qksA7OK0lt9Q
Content-Length: 2216

{
  "extreme" : [ {
    "serial_number" : "012238339999",
    "location" : {
      "location_id" : 438086787229,
      "x" : 156.01,
      "y" : 889.81,
      "latitude" : 10.0,
      "longitude" : 23.9
    },
    "network_policy_id" : 438086787230,
    "hostname" : "SanJose-AP1"
  }, {
    "serial_number" : "012238338888",
    "location" : {
      "location_id" : 438086787330,
      "x" : 56.81,
      "y" : 100.81,
      "latitude" : 20.0,
      "longitude" : 33.9
    },
    "network_policy_id" : 438086787123,
    "hostname" : "SanJose-AP2"
  } ],
  "exos" : [ {
    "serial_number" : "JA0ZZZZG-88801",
    "location" : {
      "location_id" : 438086787999,
      "x" : 16.01,
      "y" : 89.81,
      "latitude" : 30.0,
      "longitude" : 43.9
    },
    "network_policy_id" : 438086787230,
    "hostname" : "5420F-48P-4XL-SwitchEngine"
  } ],
  "voss" : [ {
    "serial_number" : "2034G-00113",
    "location" : {
      "location_id" : 438086787339,
      "x" : 153.01,
      "y" : 819.81,
      "latitude" : 102.0,
      "longitude" : 213.9
    },
    "network_policy_id" : 438086787120,
    "hostname" : "5520-48W-FabricEngine"
  } ],
  "wing" : [ {
    "serial_number" : "AAAA-BBBB",
    "mac_address" : "bc:d0:22:11:aa:bb",
    "location" : {
      "location_id" : 438086787539,
      "x" : 34.01,
      "y" : 23.12,
      "latitude" : 202.0,
      "longitude" : 63.9
    },
    "network_policy_id" : 438086787120,
    "hostname" : "WingAP-3321"
  } ],
  "dell" : [ {
    "serial_number" : "XXX-AAAAA",
    "service_tag" : "TAG-AC001",
    "location" : {
      "location_id" : 438086787555,
      "x" : 341.01,
      "y" : 232.12,
      "latitude" : 112.0,
      "longitude" : 632.9
    },
    "network_policy_id" : 438086787121,
    "hostname" : "DellSwitch-8818"
  } ],
  "dt" : [ {
    "digital_twin_device" : {
      "make" : "FABRIC_ENGINE",
      "model" : "DT_5320_16P_4XE_DC",
      "os_type" : "DT-OS-TYPE",
      "os_version" : "8.8.1.0"
    },
    "location" : {
      "location_id" : 438086787555,
      "x" : 34.01,
      "y" : 23.12,
      "latitude" : 12.0,
      "longitude" : 672.9
    },
    "network_policy_id" : 438086787222,
    "hostname" : "DT-NAME"
  } ],
  "unmanaged" : true
}

Request Parameters

Parameter Description

async

Whether running this request as async or not

Request Fields

Path Type Description

extreme[].serial_number

String

The serial number of Extreme/Aerohive device.

extreme[].location.location_id

Number

The assigned location ID, it must be FLOOR type.

extreme[].location.x

Number

The horizontal value in the floor map.

extreme[].location.y

Number

The vertical value in the floor map.

extreme[].location.latitude

Number

The latitude in the geography.

extreme[].location.longitude

Number

The longitude in the geography.

extreme[].network_policy_id

Number

The assigned network policy id.

extreme[].hostname

String

The assigned device hostname.

exos[].serial_number

String

The serial number of ExtremeXOS (EXOS) device.

exos[].location.location_id

Number

The assigned location ID, it must be FLOOR type.

exos[].location.x

Number

The horizontal value in the floor map.

exos[].location.y

Number

The vertical value in the floor map.

exos[].location.latitude

Number

The latitude in the geography.

exos[].location.longitude

Number

The longitude in the geography.

exos[].network_policy_id

Number

The assigned network policy id.

exos[].hostname

String

The assigned device hostname.

voss[].serial_number

String

The serial number of VSP Operating System Software (VOSS) device.

voss[].location.location_id

Number

The assigned location ID, it must be FLOOR type.

voss[].location.x

Number

The horizontal value in the floor map.

voss[].location.y

Number

The vertical value in the floor map.

voss[].location.latitude

Number

The latitude in the geography.

voss[].location.longitude

Number

The longitude in the geography.

voss[].network_policy_id

Number

The assigned network policy id.

voss[].hostname

String

The assigned device hostname.

wing[].serial_number

String

The serial number of ExtremeWireless (WiNG) device.

wing[].mac_address

String

The mac address of ExtremeWireless (WiNG) device.

wing[].location.location_id

Number

The assigned location ID, it must be FLOOR type.

wing[].location.x

Number

The horizontal value in the floor map.

wing[].location.y

Number

The vertical value in the floor map.

wing[].location.latitude

Number

The latitude in the geography.

wing[].location.longitude

Number

The longitude in the geography.

wing[].network_policy_id

Number

The assigned network policy id.

wing[].hostname

String

The assigned device hostname.

dell[].serial_number

String

The serial number of Dell device.

dell[].service_tag

String

The service tag of Dell device.

dell[].location.location_id

Number

The assigned location ID, it must be FLOOR type.

dell[].location.x

Number

The horizontal value in the floor map.

dell[].location.y

Number

The vertical value in the floor map.

dell[].location.latitude

Number

The latitude in the geography.

dell[].location.longitude

Number

The longitude in the geography.

dell[].network_policy_id

Number

The assigned network policy id.

dell[].hostname

String

The assigned device hostname.

dt[].digital_twin_device.make

String

The Digital Twin device make.

dt[].digital_twin_device.model

String

The Digital Twin device model.

dt[].digital_twin_device.os_type

String

The OS Type of the Digital Twin device.

dt[].digital_twin_device.os_version

String

The supported OS versions of the Digital Twin device.

dt[].location.location_id

Number

The assigned location ID, it must be FLOOR type.

dt[].location.x

Number

The horizontal value in the floor map.

dt[].location.y

Number

The vertical value in the floor map.

dt[].location.latitude

Number

The latitude in the geography.

dt[].location.longitude

Number

The longitude in the geography.

dt[].network_policy_id

Number

The assigned network policy id.

dt[].hostname

String

The assigned device hostname.

unmanaged

Boolean

Whether to unmanage the devices.

HTTP Response

HTTP/1.1 202 Accepted
Location: http://localhost:-1/operations/operation-id
Pragma: no-cache
RateLimit-Remaining: 7277
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
Retry-After: 2
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/:advanced-onboard?async=true' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgyMiwiZXhwIjoxNzE5MjU1NjIyfQ.LxaCJGR3QQizwMs7fwviS81KDDjQOa_qksA7OK0lt9Q' \
    -d '{
  "extreme" : [ {
    "serial_number" : "012238339999",
    "location" : {
      "location_id" : 438086787229,
      "x" : 156.01,
      "y" : 889.81,
      "latitude" : 10.0,
      "longitude" : 23.9
    },
    "network_policy_id" : 438086787230,
    "hostname" : "SanJose-AP1"
  }, {
    "serial_number" : "012238338888",
    "location" : {
      "location_id" : 438086787330,
      "x" : 56.81,
      "y" : 100.81,
      "latitude" : 20.0,
      "longitude" : 33.9
    },
    "network_policy_id" : 438086787123,
    "hostname" : "SanJose-AP2"
  } ],
  "exos" : [ {
    "serial_number" : "JA0ZZZZG-88801",
    "location" : {
      "location_id" : 438086787999,
      "x" : 16.01,
      "y" : 89.81,
      "latitude" : 30.0,
      "longitude" : 43.9
    },
    "network_policy_id" : 438086787230,
    "hostname" : "5420F-48P-4XL-SwitchEngine"
  } ],
  "voss" : [ {
    "serial_number" : "2034G-00113",
    "location" : {
      "location_id" : 438086787339,
      "x" : 153.01,
      "y" : 819.81,
      "latitude" : 102.0,
      "longitude" : 213.9
    },
    "network_policy_id" : 438086787120,
    "hostname" : "5520-48W-FabricEngine"
  } ],
  "wing" : [ {
    "serial_number" : "AAAA-BBBB",
    "mac_address" : "bc:d0:22:11:aa:bb",
    "location" : {
      "location_id" : 438086787539,
      "x" : 34.01,
      "y" : 23.12,
      "latitude" : 202.0,
      "longitude" : 63.9
    },
    "network_policy_id" : 438086787120,
    "hostname" : "WingAP-3321"
  } ],
  "dell" : [ {
    "serial_number" : "XXX-AAAAA",
    "service_tag" : "TAG-AC001",
    "location" : {
      "location_id" : 438086787555,
      "x" : 341.01,
      "y" : 232.12,
      "latitude" : 112.0,
      "longitude" : 632.9
    },
    "network_policy_id" : 438086787121,
    "hostname" : "DellSwitch-8818"
  } ],
  "dt" : [ {
    "digital_twin_device" : {
      "make" : "FABRIC_ENGINE",
      "model" : "DT_5320_16P_4XE_DC",
      "os_type" : "DT-OS-TYPE",
      "os_version" : "8.8.1.0"
    },
    "location" : {
      "location_id" : 438086787555,
      "x" : 34.01,
      "y" : 23.12,
      "latitude" : 12.0,
      "longitude" : 672.9
    },
    "network_policy_id" : 438086787222,
    "hostname" : "DT-NAME"
  } ],
  "unmanaged" : true
}'

Reboot devices

POST /devices/:reboot

Request Fields

Path Type Description

ids

Array

The device ID list.

HTTP Request

POST /devices/:reboot HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgyMiwiZXhwIjoxNzE5MjU1NjIyfQ.LxaCJGR3QQizwMs7fwviS81KDDjQOa_qksA7OK0lt9Q
Content-Length: 58

{
  "ids" : [ 438086664193, 438086664194, 438086664195 ]
}

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
RateLimit-Remaining: 7279
Expires: 0
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/:reboot' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgyMiwiZXhwIjoxNzE5MjU1NjIyfQ.LxaCJGR3QQizwMs7fwviS81KDDjQOa_qksA7OK0lt9Q' \
    -d '{
  "ids" : [ 438086664193, 438086664194, 438086664195 ]
}'

Change status to Unmanaged

Change device management status to Unmanaged status.

POST /devices/:unmanage

Request Fields

Path Type Description

ids

Array

The device ID list.

HTTP Request

POST /devices/:unmanage HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgyMCwiZXhwIjoxNzE5MjU1NjIwfQ.tC5no9q6HT9_oNdAoYUUasc7xFeedWGphVi_Nyx2Px8
Content-Type: application/json
Content-Length: 58

{
  "ids" : [ 438086664193, 438086664194, 438086664195 ]
}

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
RateLimit-Remaining: 7313
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/:unmanage' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgyMCwiZXhwIjoxNzE5MjU1NjIwfQ.tC5no9q6HT9_oNdAoYUUasc7xFeedWGphVi_Nyx2Px8' \
    -H 'Content-Type: application/json' \
    -d '{
  "ids" : [ 438086664193, 438086664194, 438086664195 ]
}'

Get one device detail

GET /devices/{id}

Path parameters

Table 23. /devices/{id}
Parameter Description

id

Device ID

Request Parameters

Parameter Description

views

A view is a collection of device fields.
Currently supported views are basic, detail, status, client, location, full.
[Basic View]: id, org_id, serial_number, service_tag, mac_address, simulated, device_function, product_type, hostname, ip_address, software_version, managed_by, device_admin_state, connected, description
[Detail View]: id, org_id, create_time, update_time, serial_number, service_tag, mac_address, simulated, device_function, product_type, hostname, ip_address, software_version, managed_by, device_admin_state, connected, last_connect_time, primary_dns_server_address, subnet_mask, default_gateway, ipv6_address, ipv6_netmask, display_version
[Status View]: id, device_admin_state, connected, description
[Client View]: id, active_clients
[Location View]: id, location_id, locations.

fields

The device fields to return.
[All available fields]: id, create_time, update_time, org_id, org_name, location_id, serial_number, mac_address, device_function, product_type, hostname, ip_address, software_version, device_admin_state, connected, last_connect_time, network_policy_name, network_policy_id, primary_ntp_server_address, primary_dns_server_address, subnet_mask, default_gateway, ipv6_address, ipv6_netmask, simulated, display_version, active_clients, locations, description, country_code, lldp_cdp_info

HTTP Request

GET /devices/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgyMSwiZXhwIjoxNzE5MjU1NjIxfQ.UaAA_A_YY3f8svF37fLEZn-QWSPMIq6omz25BDXCH2A
Content-Type: application/json

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.

network_policy_name

String

The device network policy name

network_policy_id

Number

The device network policy ID

primary_ntp_server_address

String

The primary NTP server address of the device

primary_dns_server_address

String

The primary DNS server address of the device

subnet_mask

String

The subnet mask of the device

default_gateway

String

The default gateway of device

ipv6_address

String

The ipv6 address of the device

ipv6_netmask

Number

The ipv6 netmask of the device

simulated

Boolean

Device is simulated or not

display_version

String

The device display version

active_clients

Number

The active clients for the device

location_id

Number

The device location ID

locations

Array

The device detailed location

lldp_cdp_infos

Array

The device LLDP/CDP information

country_code

Number

The device assigned country code

description

String

The device description

config_mismatch

Boolean

Config audit status(MATCHED or UNMATCHED)

managed_by

String

The managed application for the device

thread0_eui64

String

Thread router EUI64

thread0_ext_mac

String

Thread router extended MAC address

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Length: 1032
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
RateLimit-Remaining: 7294

{
  "id" : 1,
  "create_time" : "2024-06-17T19:00:21.000+0000",
  "update_time" : "2024-06-17T19:00:21.000+0000",
  "org_id" : 10,
  "serial_number" : "19656973625857",
  "service_tag" : "",
  "mac_address" : "NWDikRH5QZ4N",
  "device_function" : "AP",
  "product_type" : "AP_230",
  "hostname" : "PLAN-6216E1-1",
  "ip_address" : "192.168.56.1",
  "software_version" : "8.4.10.0",
  "device_admin_state" : "MANAGED",
  "connected" : true,
  "last_connect_time" : "2024-06-17T19:00:21.000+0000",
  "network_policy_name" : "test-nwp",
  "network_policy_id" : 1,
  "primary_ntp_server_address" : "",
  "primary_dns_server_address" : "",
  "subnet_mask" : "",
  "default_gateway" : "",
  "ipv6_address" : "",
  "ipv6_netmask" : 0,
  "simulated" : false,
  "display_version" : "",
  "active_clients" : 0,
  "location_id" : 0,
  "locations" : [ ],
  "country_code" : 840,
  "description" : "Device description",
  "lldp_cdp_infos" : [ ],
  "config_mismatch" : true,
  "managed_by" : "",
  "thread0_eui64" : "",
  "thread0_ext_mac" : ""
}

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/438086664193' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgyMSwiZXhwIjoxNzE5MjU1NjIxfQ.UaAA_A_YY3f8svF37fLEZn-QWSPMIq6omz25BDXCH2A' \
    -H 'Content-Type: application/json'

Delete device

Delete one device.

DELETE /devices/{id}

Path parameters

Table 24. /devices/{id}
Parameter Description

id

Device ID

HTTP Request

DELETE /devices/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgyMSwiZXhwIjoxNzE5MjU1NjIxfQ.UaAA_A_YY3f8svF37fLEZn-QWSPMIq6omz25BDXCH2A
Content-Type: application/json

HTTP Response

HTTP/1.1 200 OK
RateLimit-Remaining: 7287
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/438086664193' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgyMSwiZXhwIjoxNzE5MjU1NjIxfQ.UaAA_A_YY3f8svF37fLEZn-QWSPMIq6omz25BDXCH2A' \
    -H 'Content-Type: application/json'

Send CLI to one device

Send CLI to one device.

POST /devices/{id}/:cli

Path parameters

Table 25. /devices/{id}/:cli
Parameter Description

id

Device ID

Request Fields

Path Type Description

[]

Array

The request CLIs

HTTP Request

POST /devices/438086664193/:cli HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgyMSwiZXhwIjoxNzE5MjU1NjIxfQ.UaAA_A_YY3f8svF37fLEZn-QWSPMIq6omz25BDXCH2A
Content-Type: application/json
Content-Length: 35

[ "CLI_to_send_1", "CLI_to_send2" ]

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
Content-Length: 32
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
RateLimit-Remaining: 7290
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "device_cli_outputs" : { }
}

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/438086664193/:cli' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgyMSwiZXhwIjoxNzE5MjU1NjIxfQ.UaAA_A_YY3f8svF37fLEZn-QWSPMIq6omz25BDXCH2A' \
    -H 'Content-Type: application/json' \
    -d '[ "CLI_to_send_1", "CLI_to_send2" ]'

Change status to Managed for one device

Change device management status to Managed status.

POST /devices/{id}/:manage

Path parameters

Table 26. /devices/{id}/:manage
Parameter Description

id

Device ID

HTTP Request

POST /devices/438086664193/:manage HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgyMiwiZXhwIjoxNzE5MjU1NjIyfQ.LxaCJGR3QQizwMs7fwviS81KDDjQOa_qksA7OK0lt9Q

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
RateLimit-Remaining: 7282
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/438086664193/:manage' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgyMiwiZXhwIjoxNzE5MjU1NjIyfQ.LxaCJGR3QQizwMs7fwviS81KDDjQOa_qksA7OK0lt9Q'

Reboot one device

POST /devices/{id}/:reboot

Path parameters

Table 27. /devices/{id}/:reboot
Parameter Description

id

Device ID

HTTP Request

POST /devices/438086664193/:reboot HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxODY1MDgxOSwiZXhwIjoxNzE5MjU1NjE5fQ.bC2mSP0Clm4nuHOh5N4SEsqBRdSfzcZKX-SlNB5OUFM
Content-Type: application/json

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
RateLimit-Remaining: 7319
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/438086664193/:reboot' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZX