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 |
---|---|---|
|
|
The login username |
|
|
The login password |
HTTP Request
POST /login HTTP/1.1
Host: api.extremecloudiq.com
Content-Length: 65
Content-Type: application/json
{
"password" : "aerohive",
"username" : "admin@cust001.com"
}
cURL Request
$ curl 'https://api.extremecloudiq.com/login' -i -X POST \
-H 'Content-Type: application/json' \
-d '{
"password" : "aerohive",
"username" : "admin@cust001.com"
}'
Response Fields
Path | Type | Description |
---|---|---|
|
|
The access token with JWT format issued by ExtremeCloud IQ |
|
|
The type of token, only supports "Bearer" currently |
|
|
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-Length: 2522
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
{
"access_token" : "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDQ5LCJleHAiOjE3MDA2NTk4NDl9.k2riT924CHIk0dzf0WJYcNI6A7p87WACxYVk1vMFAa4",
"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" : "05d695c66e564ec88529d6c458336a67",
"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
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDQ4LCJleHAiOjE3MDA2NTk4NDh9.9zrI4jm6q_mafUm7A468NSBIXMtxmOk3if1hp4umKVs
Content-Type: application/json
cURL Request
$ curl 'https://api.extremecloudiq.com/logout' -i -X POST \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDQ4LCJleHAiOjE3MDA2NTk4NDh9.9zrI4jm6q_mafUm7A468NSBIXMtxmOk3if1hp4umKVs' \
-H 'Content-Type: application/json'
Response Fields
No response field will be returned.
Successful Logout Response
HTTP/1.1 200 OK
RateLimit-Remaining: 7298
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
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" : "f1554a7df9ed46499022923d2e232ef0"
}
Authorization
Generate API token
POST /auth/apitoken
Request Fields
Path | Type | Description |
---|---|---|
|
|
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. |
|
|
The permission list. |
|
|
The token description |
HTTP Request
POST /auth/apitoken HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDI1LCJleHAiOjE3MDA2NTk4MjV9.FKsvBfhcvv8bIkZbvBZ7eB4Hd8DN5L9Gd4enn-cDuXM
Host: api.extremecloudiq.com
Content-Type: application/json
Content-Length: 118
{
"expire_time" : 1700058625,
"description" : "API Token for account read.",
"permissions" : [ "write*:auth" ]
}
Response Fields
Path | Type | Description |
---|---|---|
|
|
The API access token. |
|
|
The create timestamp. |
|
|
The expire timestamp. |
|
|
The user ID who created the API token. |
|
|
The customer ID who owns the API token. |
|
|
The description for the API token. |
|
|
The permissions for the API token. |
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
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" : "2023-11-15T13:30:25.000+0000",
"expire_time" : "2023-11-15T14:30:25.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDI1LCJleHAiOjE3MDA2NTk4MjV9.FKsvBfhcvv8bIkZbvBZ7eB4Hd8DN5L9Gd4enn-cDuXM' \
-H 'Content-Type: application/json' \
-d '{
"expire_time" : 1700058625,
"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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDI1LCJleHAiOjE3MDA2NTk4MjV9.FKsvBfhcvv8bIkZbvBZ7eB4Hd8DN5L9Gd4enn-cDuXM
Host: api.extremecloudiq.com
Content-Type: application/json
Response Fields
Path | Type | Description |
---|---|---|
|
|
Account ID. |
|
|
Account login name. |
|
|
User role. |
|
|
User’s home ownerId. |
|
|
User’s data center. |
|
|
Login user’s permissions. |
|
|
The time at which the JWT was issued. |
|
|
The expiration time on or after which the JWT MUST NOT be accepted for processing. |
|
|
How many seconds when this token will expires. |
HTTP Response
HTTP/1.1 200 OK
RateLimit-Remaining: 7320
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Length: 1893
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", "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", "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" ],
"issued_at" : "2023-11-15T13:30:25.000+0000",
"expiration_time" : "2023-11-22T13:30:25.000+0000",
"expires_in" : 604799
}
cURL Request
$ curl 'https://api.extremecloudiq.com/auth/apitoken/info' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDI1LCJleHAiOjE3MDA2NTk4MjV9.FKsvBfhcvv8bIkZbvBZ7eB4Hd8DN5L9Gd4enn-cDuXM' \
-H 'Content-Type: application/json'
Validate API token
POST /auth/apitoken/:validate
Request Body
eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDI1LCJleHAiOjE3MDA2NTk4MjV9.FKsvBfhcvv8bIkZbvBZ7eB4Hd8DN5L9Gd4enn-cDuXM
HTTP Request
POST /auth/apitoken/:validate HTTP/1.1
Host: api.extremecloudiq.com
Content-Length: 2445
Content-Type: text/plain
eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDI1LCJleHAiOjE3MDA2NTk4MjV9.FKsvBfhcvv8bIkZbvBZ7eB4Hd8DN5L9Gd4enn-cDuXM
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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDI1LCJleHAiOjE3MDA2NTk4MjV9.FKsvBfhcvv8bIkZbvBZ7eB4Hd8DN5L9Gd4enn-cDuXM'
Get user permissions
GET /auth/permissions
HTTP Request
GET /auth/permissions HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDI5LCJleHAiOjE3MDA2NTk4Mjl9.DavsuaoS9K8Mflb7dcok-nr4CoHynZiAmVHKxADIzFQ
Content-Type: application/json
Response Fields
Path | Type | Description |
---|---|---|
|
|
The permission name |
|
|
The description for the permission |
|
|
The category for the permission |
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
RateLimit-Remaining: 7322
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: 12283
[ {
"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" : "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" : "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"
} ]
cURL Request
$ curl 'https://api.extremecloudiq.com/auth/permissions' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDI5LCJleHAiOjE3MDA2NTk4Mjl9.DavsuaoS9K8Mflb7dcok-nr4CoHynZiAmVHKxADIzFQ' \
-H 'Content-Type: application/json'
Check permissions
POST /auth/permissions/:check
Request Fields
Path | Type | Description |
---|---|---|
|
|
The request URI. |
|
|
The HTTP request method. |
HTTP Request
POST /auth/permissions/:check HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDI5LCJleHAiOjE3MDA2NTk4Mjl9.DavsuaoS9K8Mflb7dcok-nr4CoHynZiAmVHKxADIzFQ
Content-Length: 70
Content-Type: application/json
{
"uri" : "http://localhost:8081/account/info",
"method" : "get"
}
Response Fields
Path | Type | Description |
---|---|---|
|
|
The valid roles for request URI and request method |
|
|
The permission name. |
|
|
The permission description. |
|
|
The category for the permission. |
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Remaining: 7321
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: 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 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDI5LCJleHAiOjE3MDA2NTk4Mjl9.DavsuaoS9K8Mflb7dcok-nr4CoHynZiAmVHKxADIzFQ' \
-H 'Content-Type: application/json' \
-d '{
"uri" : "http://localhost:8081/account/info",
"method" : "get"
}'
Account
Switch account
POST /account/:switch
Request Parameters
Parameter | Description |
---|---|
|
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
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDQwLCJleHAiOjE3MDA2NTk4NDB9.SSc-vNJaWPJz2DzkFm0HnHILhVVFUQB3_wmOnDbh75E
id=1
Response Fields
Path | Type | Description |
---|---|---|
|
|
Access token for the new account. |
|
|
The type of token, only supports "Bearer" currently |
|
|
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
X-Content-Type-Options: nosniff
Content-Length: 2522
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
RateLimit-Remaining: 7282
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
{
"access_token" : "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDQwLCJleHAiOjE3MDA2NTk4NDB9.SSc-vNJaWPJz2DzkFm0HnHILhVVFUQB3_wmOnDbh75E",
"token_type" : "Bearer",
"expires_in" : 604800
}
cURL Request
$ curl 'https://api.extremecloudiq.com/account/:switch' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDQwLCJleHAiOjE3MDA2NTk4NDB9.SSc-vNJaWPJz2DzkFm0HnHILhVVFUQB3_wmOnDbh75E' \
-d 'id=1'
List external accounts
GET /account/external
HTTP Request
GET /account/external HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDQwLCJleHAiOjE3MDA2NTk4NDB9.SSc-vNJaWPJz2DzkFm0HnHILhVVFUQB3_wmOnDbh75E
Response Fields
Path | Type | Description |
---|---|---|
|
|
The external account ID. |
|
|
The external account name. |
|
|
The create time. |
|
|
The last update time. |
|
|
The default Regional Data Center (RDC) to hold data from customer network. |
|
|
The alias of the external account. |
|
|
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
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: 7283
Content-Length: 433
[ {
"id" : 1,
"create_time" : "2023-11-15T13:30:40.000+0000",
"update_time" : "2023-11-15T13:30:40.000+0000",
"name" : "admin1@cust001.com",
"alias" : "admin1",
"active" : false,
"data_center" : "VA2"
}, {
"id" : 2,
"create_time" : "2023-11-15T13:30:40.000+0000",
"update_time" : "2023-11-15T13:30:40.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 'Content-Type: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDQwLCJleHAiOjE3MDA2NTk4NDB9.SSc-vNJaWPJz2DzkFm0HnHILhVVFUQB3_wmOnDbh75E'
Get basic info
GET /account/home
HTTP Request
GET /account/home HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDQwLCJleHAiOjE3MDA2NTk4NDB9.SSc-vNJaWPJz2DzkFm0HnHILhVVFUQB3_wmOnDbh75E
Response Fields
Path | Type | Description |
---|---|---|
|
|
Account ID. |
|
|
Account name. |
|
|
Account create time. |
|
|
The last update time. |
|
|
Account type. |
|
|
Account mode. |
|
|
The max API requests per minute. |
|
|
The default Regional Data Center (RDC) to hold data from customer network. |
|
|
The industry of the account belongs to. |
|
|
The country for the account. |
|
|
The state for the account, if any. |
|
|
The city for the account. |
|
|
The address for the account. |
|
|
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
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: 7285
{
"id" : 1,
"create_time" : "2023-11-15T13:30:40.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 'Content-Type: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDQwLCJleHAiOjE3MDA2NTk4NDB9.SSc-vNJaWPJz2DzkFm0HnHILhVVFUQB3_wmOnDbh75E'
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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDQwLCJleHAiOjE3MDA2NTk4NDB9.SSc-vNJaWPJz2DzkFm0HnHILhVVFUQB3_wmOnDbh75E
Response Fields
Path | Type | Description |
---|---|---|
|
|
Customer ID. a.k.a Salesforce customer ID. |
|
|
Account name. |
|
|
Owner Id. a.k.a VHM account ID. |
|
|
Total # of licensed devices. |
|
|
Whether HHM/HIQ is enabled or if standalone VIQ. |
|
|
The license subscription expired. |
|
|
The license info list. |
|
|
The license id. |
|
|
The license status. |
|
|
The license mode. |
|
|
The license create time. |
|
|
The license update time. |
|
|
The license active time. |
|
|
The license expire time. |
|
|
The license entitlement key. |
|
|
The license entitlement type. |
|
|
The device number. |
|
|
The activated device number. |
|
|
The available device number. |
|
|
The Gemalto license type. |
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: 1121
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
{
"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" : "2023-11-15T13:30:40.000+0000",
"update_time" : "2023-11-15T13:30:40.000+0000",
"status" : "EVAL",
"active_date" : "2023-11-15T13:30:40.000+0000",
"expire_date" : "2024-11-15T13:30:40.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" : "2023-09-15T12:30:40.000+0000",
"update_time" : "2023-09-15T12:30:40.000+0000",
"status" : "EVAL",
"active_date" : "2023-10-15T12:30:40.000+0000",
"expire_date" : "2023-11-08T13:30:40.000+0000",
"entitlement_key" : "wwwww-wwwww-wwwww-wwwww-wwwww-wwwww",
"entitlement_type" : "EVALUATION",
"mode" : "EVAL",
"devices" : 100,
"activated" : 0,
"available" : 0,
"license_type" : ""
} ]
}
cURL Request
$ curl 'https://api.extremecloudiq.com/account/viq' -i -X GET \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDQwLCJleHAiOjE3MDA2NTk4NDB9.SSc-vNJaWPJz2DzkFm0HnHILhVVFUQB3_wmOnDbh75E'
VIQ backup
POST /account/viq/:backup
HTTP Request
POST /account/viq/:backup HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDQwLCJleHAiOjE3MDA2NTk4NDB9.SSc-vNJaWPJz2DzkFm0HnHILhVVFUQB3_wmOnDbh75E
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/account/viq/:backup' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDQwLCJleHAiOjE3MDA2NTk4NDB9.SSc-vNJaWPJz2DzkFm0HnHILhVVFUQB3_wmOnDbh75E'
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
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDQwLCJleHAiOjE3MDA2NTk4NDB9.SSc-vNJaWPJz2DzkFm0HnHILhVVFUQB3_wmOnDbh75E
Response Fields
Path | Type | Description |
---|---|---|
|
|
The default device password. |
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Remaining: 7288
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 'Content-Type: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDQwLCJleHAiOjE3MDA2NTk4NDB9.SSc-vNJaWPJz2DzkFm0HnHILhVVFUQB3_wmOnDbh75E'
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
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDQwLCJleHAiOjE3MDA2NTk4NDB9.SSc-vNJaWPJz2DzkFm0HnHILhVVFUQB3_wmOnDbh75E
Content-Length: 15
"'Aerohive123'"
HTTP Response
HTTP/1.1 200 OK
RateLimit-Remaining: 7286
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 'Content-Type: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDQwLCJleHAiOjE3MDA2NTk4NDB9.SSc-vNJaWPJz2DzkFm0HnHILhVVFUQB3_wmOnDbh75E' \
-d '"'Aerohive123'"'
User
List users
GET /users
Request Parameters
Parameter | Description |
---|---|
|
Page number |
|
Page size |
HTTP Request
GET /users?page=1&limit=10 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDIxLCJleHAiOjE3MDA2NTk4MjF9.Yrcw-AK5Rtecnz7hLVDFuHbE-gahF4NRopu5Fp-4xn8
Host: api.extremecloudiq.com
Content-Type: application/json
Response Fields
Path | Type | Description |
---|---|---|
|
|
The current page number. |
|
|
The element count of the current page. |
|
|
The total page number based on request page size. |
|
|
The total element count. |
|
|
The user ID. |
|
|
The create time. |
|
|
The last update time. |
|
|
Login name, i.e. username or login Email. |
|
|
The first name. |
|
|
The last name, i.e. family name. |
|
|
The name to display. |
|
|
The Phone Number. |
|
|
The job title. |
|
|
The locale. |
|
|
The idle timeout in minutes, the minimum value is 5 minutes and the maximum value is 4 hours. |
|
|
The last login time. |
|
|
The HIQ org_id if it is HIQ user. |
|
|
The user role. |
|
|
The assigned location IDs. |
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Remaining: 7321
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
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" : "2023-11-15T13:30:21.000+0000",
"update_time" : "2023-11-15T13:30:21.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" : "2023-11-15T13:30:21.000+0000",
"org_id" : 0,
"location_ids" : [ 438086664193 ]
}, {
"id" : 2,
"create_time" : "2023-11-15T13:30:21.000+0000",
"update_time" : "2023-11-15T13:30:21.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" : "2023-11-15T13:30:21.000+0000",
"org_id" : 0,
"location_ids" : [ 438086664193 ]
} ]
}
cURL Request
$ curl 'https://api.extremecloudiq.com/users?page=1&limit=10' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDIxLCJleHAiOjE3MDA2NTk4MjF9.Yrcw-AK5Rtecnz7hLVDFuHbE-gahF4NRopu5Fp-4xn8' \
-H 'Content-Type: application/json'
Create new user
POST /users
Request Fields
Path | Type | Description |
---|---|---|
|
|
The login name |
|
|
The display name |
|
|
The idle timeout in minutes |
|
|
The user administrative role |
|
|
The location IDs to assign. |
HTTP Request
POST /users HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDIxLCJleHAiOjE3MDA2NTk4MjF9.Yrcw-AK5Rtecnz7hLVDFuHbE-gahF4NRopu5Fp-4xn8
Host: api.extremecloudiq.com
Content-Type: application/json
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 |
---|---|---|
|
|
User ID. |
|
|
User create time. |
|
|
User update time. |
|
|
Login name, i.e. username or login Email. |
|
|
The first name. |
|
|
The last name, i.e. family name. |
|
|
The name to display. |
|
|
The Phone Number. |
|
|
The job title. |
|
|
The locale. |
|
|
The idle timeout in minutes, the minimum value is 5 minutes and the maximum value is 4 hours. |
|
|
The last login time. |
|
|
The HIQ org_id if it is HIQ user. |
|
|
The user role. |
|
|
The assigned location IDs. |
HTTP Response
HTTP/1.1 201 Created
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
RateLimit-Remaining: 7322
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" : "2023-11-15T13:30:21.000+0000",
"update_time" : "2023-11-15T13:30:21.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" : "2023-11-15T13:30:21.000+0000",
"org_id" : 0,
"location_ids" : [ ]
}
cURL Request
$ curl 'https://api.extremecloudiq.com/users' -i -X POST \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDIxLCJleHAiOjE3MDA2NTk4MjF9.Yrcw-AK5Rtecnz7hLVDFuHbE-gahF4NRopu5Fp-4xn8' \
-H 'Content-Type: application/json' \
-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
Parameter | Description |
---|---|
|
User ID |
HTTP Request
GET /users/1 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDIxLCJleHAiOjE3MDA2NTk4MjF9.Yrcw-AK5Rtecnz7hLVDFuHbE-gahF4NRopu5Fp-4xn8
Host: api.extremecloudiq.com
Content-Type: application/json
Response Fields
Path | Type | Description |
---|---|---|
|
|
User ID. |
|
|
User create time. |
|
|
User update time. |
|
|
Login name, i.e. username or login Email. |
|
|
The first name. |
|
|
The last name, i.e. family name. |
|
|
The name to display. |
|
|
The Phone Number. |
|
|
The job title. |
|
|
The locale. |
|
|
The idle timeout in minutes, the minimum value is 5 minutes and the maximum value is 4 hours. |
|
|
The last login time. |
|
|
The HIQ org_id if it is HIQ user. |
|
|
The user role. |
|
|
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: 7317
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" : "2023-11-15T13:30:21.000+0000",
"update_time" : "2023-11-15T13:30:21.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" : "2023-11-15T13:30:21.000+0000",
"org_id" : 0,
"location_ids" : [ ]
}
cURL Request
$ curl 'https://api.extremecloudiq.com/users/1' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDIxLCJleHAiOjE3MDA2NTk4MjF9.Yrcw-AK5Rtecnz7hLVDFuHbE-gahF4NRopu5Fp-4xn8' \
-H 'Content-Type: application/json'
Delete user
DELETE /users/{id}
Path Parameters
Parameter | Description |
---|---|
|
The location ID |
HTTP Request
DELETE /users/1 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDIwLCJleHAiOjE3MDA2NTk4MjB9.1AJ7AgUD7XWkOE4uoPgY8hbQPrMjdhhWoraYjzII4KY
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
RateLimit-Remaining: 7323
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/1' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDIwLCJleHAiOjE3MDA2NTk4MjB9.1AJ7AgUD7XWkOE4uoPgY8hbQPrMjdhhWoraYjzII4KY' \
-H 'Content-Type: application/json'
Update user
PATCH /users/{id}
Path Parameters
Parameter | Description |
---|---|
|
The location ID |
Request Fields
Path | Type | Description |
---|---|---|
|
|
The login name |
|
|
The display name |
|
|
The idle timeout in minutes |
|
|
The user administrative role |
|
|
The location IDs to assign. |
HTTP Request
PATCH /users/1 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDIxLCJleHAiOjE3MDA2NTk4MjF9.Yrcw-AK5Rtecnz7hLVDFuHbE-gahF4NRopu5Fp-4xn8
Host: api.extremecloudiq.com
Content-Type: application/json
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 |
---|---|---|
|
|
User ID. |
|
|
User create time. |
|
|
User update time. |
|
|
Login name, i.e. username or login Email. |
|
|
The first name. |
|
|
The last name, i.e. family name. |
|
|
The name to display. |
|
|
The Phone Number. |
|
|
The job title. |
|
|
The locale. |
|
|
The idle timeout in minutes, the minimum value is 5 minutes and the maximum value is 4 hours. |
|
|
The last login time. |
|
|
The HIQ org_id if it is HIQ user. |
|
|
The user role. |
|
|
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
X-Content-Type-Options: nosniff
RateLimit-Remaining: 7319
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" : "2023-11-15T13:30:21.000+0000",
"update_time" : "2023-11-15T13:30:21.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" : "2023-11-15T13:30:21.000+0000",
"org_id" : 0,
"location_ids" : [ 438086664193 ]
}
cURL Request
$ curl 'https://api.extremecloudiq.com/users/1' -i -X PATCH \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDIxLCJleHAiOjE3MDA2NTk4MjF9.Yrcw-AK5Rtecnz7hLVDFuHbE-gahF4NRopu5Fp-4xn8' \
-H 'Content-Type: application/json' \
-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 number |
|
Page size |
HTTP Request
GET /users/external?page=1&limit=10 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDIxLCJleHAiOjE3MDA2NTk4MjF9.Yrcw-AK5Rtecnz7hLVDFuHbE-gahF4NRopu5Fp-4xn8
Host: api.extremecloudiq.com
Content-Type: application/json
Response Fields
Path | Type | Description |
---|---|---|
|
|
The current page number. |
|
|
The element count of the current page. |
|
|
The total page number based on request page size. |
|
|
The total element count. |
|
|
The external user ID. |
|
|
The create time. |
|
|
The last update time. |
|
|
Login name, i.e. username or login Email. |
|
|
The HIQ org_id if it is HIQ user. |
|
|
The user role. |
|
|
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
Content-Length: 878
X-Content-Type-Options: nosniff
RateLimit-Remaining: 7318
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" : "2023-11-15T13:30:21.000+0000",
"update_time" : "2023-11-15T13:30:21.000+0000",
"login_name" : "operator1@extermenetworks.com",
"user_role" : "OPERATOR",
"org_id" : 0,
"location_ids" : [ 438086664193 ]
}, {
"id" : 2,
"create_time" : "2023-11-15T13:30:21.000+0000",
"update_time" : "2023-11-15T13:30:21.000+0000",
"login_name" : "operator2@extermenetworks.com",
"user_role" : "OPERATOR",
"org_id" : 0,
"location_ids" : [ 438086664193 ]
}, {
"id" : 3,
"create_time" : "2023-11-15T13:30:21.000+0000",
"update_time" : "2023-11-15T13:30:21.000+0000",
"login_name" : "operator3@extermenetworks.com",
"user_role" : "OPERATOR",
"org_id" : 0,
"location_ids" : [ 438086664193 ]
} ]
}
cURL Request
$ curl 'https://api.extremecloudiq.com/users/external?page=1&limit=10' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDIxLCJleHAiOjE3MDA2NTk4MjF9.Yrcw-AK5Rtecnz7hLVDFuHbE-gahF4NRopu5Fp-4xn8' \
-H 'Content-Type: application/json'
Grant external user
POST /users/external
Request Fields
Path | Type | Description |
---|---|---|
|
|
The login name |
|
|
The user administrative role |
|
|
The HIQ organization ID if it is HIQ user |
|
|
The assigned location IDs. |
HTTP Request
POST /users/external HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDIxLCJleHAiOjE3MDA2NTk4MjF9.Yrcw-AK5Rtecnz7hLVDFuHbE-gahF4NRopu5Fp-4xn8
Host: api.extremecloudiq.com
Content-Length: 117
Content-Type: application/json
{
"login_name" : "operator1@extremenetworks.com",
"user_role" : "OPERATOR",
"location_ids" : [ 438086664193 ]
}
Response Fields
Path | Type | Description |
---|---|---|
|
|
External user ID. |
|
|
User create time. |
|
|
User update time. |
|
|
Login name, i.e. username or login Email. |
|
|
The HIQ org_id if it is HIQ user. |
|
|
The user role. |
|
|
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: 7314
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 232
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
{
"id" : 1,
"create_time" : "2023-11-15T13:30:21.000+0000",
"update_time" : "2023-11-15T13:30:21.000+0000",
"login_name" : "operator1@extermenetworks.com",
"user_role" : "OPERATOR",
"org_id" : 0,
"location_ids" : [ ]
}
cURL Request
$ curl 'https://api.extremecloudiq.com/users/external' -i -X POST \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDIxLCJleHAiOjE3MDA2NTk4MjF9.Yrcw-AK5Rtecnz7hLVDFuHbE-gahF4NRopu5Fp-4xn8' \
-H 'Content-Type: application/json' \
-d '{
"login_name" : "operator1@extremenetworks.com",
"user_role" : "OPERATOR",
"location_ids" : [ 438086664193 ]
}'
Get external user
GET /users/external/{id}
Path parameters
Parameter | Description |
---|---|
|
The external user ID |
HTTP Request
GET /users/external/1 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDIxLCJleHAiOjE3MDA2NTk4MjF9.Yrcw-AK5Rtecnz7hLVDFuHbE-gahF4NRopu5Fp-4xn8
Host: api.extremecloudiq.com
Content-Type: application/json
Response Fields
Path | Type | Description |
---|---|---|
|
|
External user ID. |
|
|
User create time. |
|
|
User update time. |
|
|
Login name, i.e. username or login Email. |
|
|
The HIQ org_id if it is HIQ user. |
|
|
The user role. |
|
|
The assigned location IDs. |
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Remaining: 7321
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: 232
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
{
"id" : 1,
"create_time" : "2023-11-15T13:30:21.000+0000",
"update_time" : "2023-11-15T13:30:21.000+0000",
"login_name" : "operator1@extermenetworks.com",
"user_role" : "OPERATOR",
"org_id" : 0,
"location_ids" : [ ]
}
cURL Request
$ curl 'https://api.extremecloudiq.com/users/external/1' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDIxLCJleHAiOjE3MDA2NTk4MjF9.Yrcw-AK5Rtecnz7hLVDFuHbE-gahF4NRopu5Fp-4xn8' \
-H 'Content-Type: application/json'
Revoke external user
DELETE /users/external/{id}
Path Parameters
Parameter | Description |
---|---|
|
The external user ID |
HTTP Request
DELETE /users/external/1 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDIxLCJleHAiOjE3MDA2NTk4MjF9.Yrcw-AK5Rtecnz7hLVDFuHbE-gahF4NRopu5Fp-4xn8
Host: api.extremecloudiq.com
Content-Type: application/json
HTTP Response
HTTP/1.1 200 OK
RateLimit-Remaining: 7320
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 DELETE \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDIxLCJleHAiOjE3MDA2NTk4MjF9.Yrcw-AK5Rtecnz7hLVDFuHbE-gahF4NRopu5Fp-4xn8' \
-H 'Content-Type: application/json'
Update external user
PATCH /users/external/{id}
Path Parameters
Parameter | Description |
---|---|
|
The external user ID |
Request Fields
Path | Type | Description |
---|---|---|
|
|
The user administrative role |
|
|
The HIQ organization ID if it is HIQ user |
|
|
The location IDs to assign. |
HTTP Request
PATCH /users/external/1 HTTP/1.1
Content-Length: 30
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDIxLCJleHAiOjE3MDA2NTk4MjF9.Yrcw-AK5Rtecnz7hLVDFuHbE-gahF4NRopu5Fp-4xn8
Host: api.extremecloudiq.com
Content-Type: application/json
{
"user_role" : "OPERATOR"
}
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: 7314
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 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDIxLCJleHAiOjE3MDA2NTk4MjF9.Yrcw-AK5Rtecnz7hLVDFuHbE-gahF4NRopu5Fp-4xn8' \
-H 'Content-Type: application/json' \
-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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU0OTk4LCJleHAiOjE3MDA2NTk3OTh9.ojmd1sLCFetMSHA5Kqw3_Se7fah-KEWILUFd5J8uHuI
Response Fields
Path | Type | Description |
---|---|---|
|
|
The user profile ID. |
|
|
The user profile name. |
|
|
The create time of user profile. |
|
|
The update time of user profile. |
|
|
The vlan profile ID. |
|
|
The vlan profile org ID. |
|
|
The create time. |
|
|
The last update time. |
|
|
The vlan profile name |
|
|
The default vlan ID. |
|
|
Enable classification. |
|
|
The classification entry id. |
|
|
The classification entry org id. |
|
|
The create time of classified entry. |
|
|
The update time of classified entry. |
|
|
The vlan ID. |
|
|
The classification assignment ID. |
|
|
The classification assignment org ID. |
|
|
The classification assignment name. |
|
|
The classification assignment description. |
|
|
The create time of classification assignment. |
|
|
The update time of classification assignment. |
|
|
The classification ID. |
|
|
Match or not match with classifications. |
|
|
The value of classification. |
|
|
The create time of classification. |
|
|
The update time of classification. |
|
|
The classification type. |
|
|
The classification reference ID. |
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: 7448
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" : "2023-11-15T13:29:58.000+0000",
"update_time" : "2023-11-15T13:29:58.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" : "2023-11-15T13:29:58.000+0000",
"update_time" : "2023-11-15T13:29:58.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" : "2023-11-15T13:29:58.000+0000",
"update_time" : "2023-11-15T13:29:58.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU0OTk4LCJleHAiOjE3MDA2NTk3OTh9.ojmd1sLCFetMSHA5Kqw3_Se7fah-KEWILUFd5J8uHuI'
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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA0LCJleHAiOjE3MDA2NTk4MDR9.8qetopCsYMJe4RxpXPJPAL6QQ5BFko3HQI_n0OOrwlU
Content-Type: application/json
Response Fields
Path | Type | Description |
---|---|---|
|
|
The organization ID list for reading data (Empty means read data from all organizations in the HIQ). |
|
|
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
RateLimit-Remaining: 7401
X-Content-Type-Options: nosniff
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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA0LCJleHAiOjE3MDA2NTk4MDR9.8qetopCsYMJe4RxpXPJPAL6QQ5BFko3HQI_n0OOrwlU' \
-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 |
---|---|---|
|
|
The organization ID for creating new data. |
|
|
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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA0LCJleHAiOjE3MDA2NTk4MDR9.8qetopCsYMJe4RxpXPJPAL6QQ5BFko3HQI_n0OOrwlU
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
RateLimit-Remaining: 7402
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' -i -X PUT \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA0LCJleHAiOjE3MDA2NTk4MDR9.8qetopCsYMJe4RxpXPJPAL6QQ5BFko3HQI_n0OOrwlU' \
-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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA0LCJleHAiOjE3MDA2NTk4MDR9.8qetopCsYMJe4RxpXPJPAL6QQ5BFko3HQI_n0OOrwlU
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: 7405
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
1
cURL Request
$ curl 'https://api.extremecloudiq.com/hiq/context/creating' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA0LCJleHAiOjE3MDA2NTk4MDR9.8qetopCsYMJe4RxpXPJPAL6QQ5BFko3HQI_n0OOrwlU' \
-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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA0LCJleHAiOjE3MDA2NTk4MDR9.8qetopCsYMJe4RxpXPJPAL6QQ5BFko3HQI_n0OOrwlU
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
RateLimit-Remaining: 7403
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/creating' -i -X PUT \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA0LCJleHAiOjE3MDA2NTk4MDR9.8qetopCsYMJe4RxpXPJPAL6QQ5BFko3HQI_n0OOrwlU' \
-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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA0LCJleHAiOjE3MDA2NTk4MDR9.8qetopCsYMJe4RxpXPJPAL6QQ5BFko3HQI_n0OOrwlU
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
RateLimit-Remaining: 7404
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
[ 1, 2, 3 ]
cURL Request
$ curl 'https://api.extremecloudiq.com/hiq/context/reading' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA0LCJleHAiOjE3MDA2NTk4MDR9.8qetopCsYMJe4RxpXPJPAL6QQ5BFko3HQI_n0OOrwlU' \
-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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA0LCJleHAiOjE3MDA2NTk4MDR9.8qetopCsYMJe4RxpXPJPAL6QQ5BFko3HQI_n0OOrwlU
Content-Type: application/json
[ 1, 2, 3 ]
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: 7406
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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA0LCJleHAiOjE3MDA2NTk4MDR9.8qetopCsYMJe4RxpXPJPAL6QQ5BFko3HQI_n0OOrwlU' \
-H 'Content-Type: application/json' \
-d '[ 1, 2, 3 ]'
Get all organizations
GET /hiq/organizations
HTTP Request
GET /hiq/organizations HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA1LCJleHAiOjE3MDA2NTk4MDV9.bVkl23D0vnN4gIqCvG9EbjE0-rKQrwan4bw0Ho_BarQ
Host: api.extremecloudiq.com
Content-Type: application/json
Response Fields
Path | Type | Description |
---|---|---|
|
|
The unique identifier. |
|
|
The create time. |
|
|
The last update time. |
|
|
The organization identifier, valid when enabling HIQ feature. |
|
|
The organization name. |
|
|
The organization type. |
|
|
tagged color for the organization. |
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Remaining: 7398
RateLimit-Limit: 7500;w=3600
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" : "2023-11-15T13:30:05.000+0000",
"update_time" : "2023-11-15T13:30:05.000+0000",
"org_id" : 1,
"name" : "Example-corp-0",
"type" : "REGULAR",
"color" : "red"
}, {
"id" : 2,
"create_time" : "2023-11-15T13:30:05.000+0000",
"update_time" : "2023-11-15T13:30:05.000+0000",
"org_id" : 2,
"name" : "Example-corp-1",
"type" : "REGULAR",
"color" : "red"
}, {
"id" : 3,
"create_time" : "2023-11-15T13:30:05.000+0000",
"update_time" : "2023-11-15T13:30:05.000+0000",
"org_id" : 3,
"name" : "Example-corp-2",
"type" : "REGULAR",
"color" : "red"
}, {
"id" : 4,
"create_time" : "2023-11-15T13:30:05.000+0000",
"update_time" : "2023-11-15T13:30:05.000+0000",
"org_id" : 4,
"name" : "Example-corp-3",
"type" : "REGULAR",
"color" : "red"
}, {
"id" : 5,
"create_time" : "2023-11-15T13:30:05.000+0000",
"update_time" : "2023-11-15T13:30:05.000+0000",
"org_id" : 5,
"name" : "Example-corp-4",
"type" : "REGULAR",
"color" : "red"
}, {
"id" : 6,
"create_time" : "2023-11-15T13:30:05.000+0000",
"update_time" : "2023-11-15T13:30:05.000+0000",
"org_id" : 6,
"name" : "Example-corp-5",
"type" : "REGULAR",
"color" : "red"
}, {
"id" : 7,
"create_time" : "2023-11-15T13:30:05.000+0000",
"update_time" : "2023-11-15T13:30:05.000+0000",
"org_id" : 7,
"name" : "Example-corp-6",
"type" : "REGULAR",
"color" : "red"
}, {
"id" : 8,
"create_time" : "2023-11-15T13:30:05.000+0000",
"update_time" : "2023-11-15T13:30:05.000+0000",
"org_id" : 8,
"name" : "Example-corp-7",
"type" : "REGULAR",
"color" : "red"
}, {
"id" : 9,
"create_time" : "2023-11-15T13:30:05.000+0000",
"update_time" : "2023-11-15T13:30:05.000+0000",
"org_id" : 9,
"name" : "Example-corp-8",
"type" : "REGULAR",
"color" : "red"
}, {
"id" : 10,
"create_time" : "2023-11-15T13:30:05.000+0000",
"update_time" : "2023-11-15T13:30:05.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA1LCJleHAiOjE3MDA2NTk4MDV9.bVkl23D0vnN4gIqCvG9EbjE0-rKQrwan4bw0Ho_BarQ' \
-H 'Content-Type: application/json'
Create organization
POST /hiq/organizations
Request Fields
Path | Type | Description |
---|---|---|
|
|
The organization name, must be unique in VIQ. |
|
|
The tagged color for the organization. |
HTTP Request
POST /hiq/organizations HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA1LCJleHAiOjE3MDA2NTk4MDV9.bVkl23D0vnN4gIqCvG9EbjE0-rKQrwan4bw0Ho_BarQ
Host: api.extremecloudiq.com
Content-Type: application/json
Content-Length: 56
{
"name" : "example-organization",
"color" : "red"
}
Response Fields
Path | Type | Description |
---|---|---|
|
|
The unique identifier. |
|
|
The create time. |
|
|
The last update time. |
|
|
The organization identifier, valid when enabling HIQ feature. |
|
|
The organization name. |
|
|
The organization type. |
|
|
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
RateLimit-Remaining: 7400
Expires: 0
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" : "2023-11-15T13:30:05.000+0000",
"update_time" : "2023-11-15T13:30:05.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA1LCJleHAiOjE3MDA2NTk4MDV9.bVkl23D0vnN4gIqCvG9EbjE0-rKQrwan4bw0Ho_BarQ' \
-H 'Content-Type: application/json' \
-d '{
"name" : "example-organization",
"color" : "red"
}'
Delete organization
DELETE /hiq/organizations/{id}
Path Parameters
Parameter | Description |
---|---|
|
Organization ID to delete. |
HTTP Request
DELETE /hiq/organizations/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA1LCJleHAiOjE3MDA2NTk4MDV9.bVkl23D0vnN4gIqCvG9EbjE0-rKQrwan4bw0Ho_BarQ
Host: api.extremecloudiq.com
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
RateLimit-Remaining: 7401
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' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA1LCJleHAiOjE3MDA2NTk4MDV9.bVkl23D0vnN4gIqCvG9EbjE0-rKQrwan4bw0Ho_BarQ' \
-H 'Content-Type: application/json'
Rename organization
POST /hiq/organizations/{id}/:rename
Path Parameters
Parameter | Description |
---|---|
|
Organization ID to delete. |
HTTP Request
POST /hiq/organizations/438086664193/:rename HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA1LCJleHAiOjE3MDA2NTk4MDV9.bVkl23D0vnN4gIqCvG9EbjE0-rKQrwan4bw0Ho_BarQ
Host: api.extremecloudiq.com
Content-Length: 21
Content-Type: application/json
New organization name
HTTP Response
HTTP/1.1 204 No Content
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
RateLimit-Remaining: 7399
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/organizations/438086664193/:rename' -i -X POST \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA1LCJleHAiOjE3MDA2NTk4MDV9.bVkl23D0vnN4gIqCvG9EbjE0-rKQrwan4bw0Ho_BarQ' \
-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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA0LCJleHAiOjE3MDA2NTk4MDR9.8qetopCsYMJe4RxpXPJPAL6QQ5BFko3HQI_n0OOrwlU
Content-Type: application/json
Response Fields
Path | Type | Description |
---|---|---|
|
|
Whether HIQ is enabled or not. |
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Content-Length: 22
Expires: 0
X-Content-Type-Options: nosniff
RateLimit-Remaining: 7406
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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA0LCJleHAiOjE3MDA2NTk4MDR9.8qetopCsYMJe4RxpXPJPAL6QQ5BFko3HQI_n0OOrwlU' \
-H 'Content-Type: application/json'
Location
Initialize location
POST /locations/:init
Request Fields
Path | Type | Description |
---|---|---|
|
|
The organization name |
|
|
The organization country code |
HTTP Request
POST /locations/:init HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA2LCJleHAiOjE3MDA2NTk4MDZ9.ylY3Y-XEiyl-wDp_j9WoZ5XxseG412qmrVngSUUpXsc
Content-Type: application/json
Content-Length: 67
{
"organization" : "Extreme Org",
"country" : "AFGHANISTAN_4"
}
Response Fields
Path | Type | Description |
---|---|---|
|
|
The location ID |
|
|
The create time |
|
|
The last update time |
|
|
The organization identifier, valid when enabling HIQ feature |
|
|
The location name |
|
|
The location unique name |
|
|
The parent location ID |
|
|
The location type |
|
|
The location address |
|
|
The children location ID |
|
|
The create time of children location |
|
|
The last update time of children location |
|
|
The organization identifier for children location, valid when enabling HIQ feature |
|
|
The name of children location |
|
|
The unique name of children location |
|
|
The parent location ID of children location |
|
|
The type of children location |
|
|
The location address of children location |
|
|
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
RateLimit-Remaining: 7391
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
{
"id" : 438086664193,
"create_time" : "2023-11-15T13:30:06.000+0000",
"update_time" : "2023-11-15T13:30:06.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" : "2023-11-15T13:30:06.000+0000",
"update_time" : "2023-11-15T13:30:06.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 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA2LCJleHAiOjE3MDA2NTk4MDZ9.ylY3Y-XEiyl-wDp_j9WoZ5XxseG412qmrVngSUUpXsc' \
-H 'Content-Type: application/json' \
-d '{
"organization" : "Extreme Org",
"country" : "AFGHANISTAN_4"
}'
Create location
POST /locations
Request Fields
Path | Type | Description |
---|---|---|
|
|
The location name |
|
|
The parent location ID |
HTTP Request
POST /locations HTTP/1.1
Host: api.extremecloudiq.com
Content-Length: 44
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA2LCJleHAiOjE3MDA2NTk4MDZ9.ylY3Y-XEiyl-wDp_j9WoZ5XxseG412qmrVngSUUpXsc
Content-Type: application/json
{
"parent_id" : 1,
"name" : "test-loc"
}
Response Fields
Path | Type | Description |
---|---|---|
|
|
The location ID |
|
|
The create time |
|
|
The last update time |
|
|
The organization identifier, valid when enabling HIQ feature |
|
|
The location name |
|
|
The location unique name |
|
|
The location parent ID |
|
|
The location type |
|
|
The location address |
|
|
The children location ID |
|
|
The create time of children location |
|
|
The last update time of children location |
|
|
The organization identifier for children location, valid when enabling HIQ feature |
|
|
The name of children location |
|
|
The unique name of children location |
|
|
The parent location ID of children location |
|
|
The type of children location |
|
|
The location address of children |
|
|
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
RateLimit-Remaining: 7381
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
{
"id" : 438086664193,
"create_time" : "2023-11-15T13:30:07.000+0000",
"update_time" : "2023-11-15T13:30:07.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" : "2023-11-15T13:30:07.000+0000",
"update_time" : "2023-11-15T13:30:07.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 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA2LCJleHAiOjE3MDA2NTk4MDZ9.ylY3Y-XEiyl-wDp_j9WoZ5XxseG412qmrVngSUUpXsc' \
-H 'Content-Type: application/json' \
-d '{
"parent_id" : 1,
"name" : "test-loc"
}'
Update location
PUT /locations/{id}
Path Parameters
Parameter | Description |
---|---|
|
The location ID |
Request Fields
Path | Type | Description |
---|---|---|
|
|
The location name |
|
|
The parent location ID |
HTTP Request
PUT /locations/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA2LCJleHAiOjE3MDA2NTk4MDZ9.ylY3Y-XEiyl-wDp_j9WoZ5XxseG412qmrVngSUUpXsc
Content-Type: application/json
Content-Length: 57
{
"parent_id" : 438086664292,
"name" : "test-loc-2"
}
Response Fields
Path | Type | Description |
---|---|---|
|
|
The location ID |
|
|
The create time |
|
|
The last update time |
|
|
The organization identifier, valid when enabling HIQ feature |
|
|
The location name |
|
|
The location unique name |
|
|
The parent location ID |
|
|
The location type |
|
|
The location address |
|
|
The children location ID |
|
|
The create time of children location |
|
|
The last update time of children location |
|
|
The organization identifier for children location, valid when enabling HIQ feature |
|
|
The name of children location |
|
|
The unique name of children location |
|
|
The parent location ID of children location |
|
|
The type of children location |
|
|
The location address of children location |
|
|
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: 7395
{
"id" : 438086664193,
"create_time" : "2023-11-15T13:30:06.000+0000",
"update_time" : "2023-11-15T13:30:06.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" : "2023-11-15T13:30:06.000+0000",
"update_time" : "2023-11-15T13:30:06.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 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA2LCJleHAiOjE3MDA2NTk4MDZ9.ylY3Y-XEiyl-wDp_j9WoZ5XxseG412qmrVngSUUpXsc' \
-H 'Content-Type: application/json' \
-d '{
"parent_id" : 438086664292,
"name" : "test-loc-2"
}'
Delete location
DELETE /locations/{id}
Path Parameters
Parameter | Description |
---|---|
|
The location ID |
Request parameters
Parameter | Description |
---|---|
|
Force deletion of this location and its descendants recursively |
HTTP Request
DELETE /locations/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA2LCJleHAiOjE3MDA2NTk4MDZ9.ylY3Y-XEiyl-wDp_j9WoZ5XxseG412qmrVngSUUpXsc
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
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
RateLimit-Remaining: 7382
cURL Request
$ curl 'https://api.extremecloudiq.com/locations/438086664193' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA2LCJleHAiOjE3MDA2NTk4MDZ9.ylY3Y-XEiyl-wDp_j9WoZ5XxseG412qmrVngSUUpXsc' \
-H 'Content-Type: application/json'
Create building
POST /locations/building
Request Fields
Path | Type | Description |
---|---|---|
|
|
The building name |
|
|
The parent location ID |
|
|
The building address line1 |
|
|
The building address line2 |
|
|
The building address city |
|
|
The building address state |
|
|
The building address postal/zip code |
HTTP Request
POST /locations/building HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA2LCJleHAiOjE3MDA2NTk4MDZ9.ylY3Y-XEiyl-wDp_j9WoZ5XxseG412qmrVngSUUpXsc
Content-Type: application/json
Content-Length: 223
{
"parent_id" : 438086664292,
"name" : "test-building",
"address" : {
"address" : "addressLine1",
"address2" : "addressLine2",
"city" : "city",
"state" : "state",
"postal_code" : "postalCode"
}
}
Response Fields
Path | Type | Description |
---|---|---|
|
|
The building ID |
|
|
The create time |
|
|
The last update time |
|
|
The organization identifier, valid when enabling HIQ feature |
|
|
The building name |
|
|
The parent location ID |
|
|
The building address line1 |
|
|
The building address line2 |
|
|
The building address city |
|
|
The building address state |
|
|
The building address postal/zip code |
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
Content-Length: 362
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: 7383
{
"id" : 438086664193,
"create_time" : "2023-11-15T13:30:06.000+0000",
"update_time" : "2023-11-15T13:30:06.000+0000",
"org_id" : 0,
"parent_id" : 438086664292,
"name" : "test-building",
"address" : {
"address" : "addressLine1",
"address2" : "addressLine2",
"city" : "city",
"state" : "state",
"postal_code" : "postalCode"
}
}
cURL Request
$ curl 'https://api.extremecloudiq.com/locations/building' -i -X POST \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA2LCJleHAiOjE3MDA2NTk4MDZ9.ylY3Y-XEiyl-wDp_j9WoZ5XxseG412qmrVngSUUpXsc' \
-H 'Content-Type: application/json' \
-d '{
"parent_id" : 438086664292,
"name" : "test-building",
"address" : {
"address" : "addressLine1",
"address2" : "addressLine2",
"city" : "city",
"state" : "state",
"postal_code" : "postalCode"
}
}'
Update building
PUT /locations/building/{id}
Path Parameters
Parameter | Description |
---|---|
|
The location ID |
Request Fields
Path | Type | Description |
---|---|---|
|
|
The building name |
|
|
The parent location ID |
|
|
The building address line1 |
|
|
The building address line2 |
|
|
The building address city |
|
|
The building address state |
|
|
The building address postal/zip code |
HTTP Request
PUT /locations/building/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA1LCJleHAiOjE3MDA2NTk4MDV9.bVkl23D0vnN4gIqCvG9EbjE0-rKQrwan4bw0Ho_BarQ
Host: api.extremecloudiq.com
Content-Type: application/json
Content-Length: 223
{
"parent_id" : 438086664292,
"name" : "test-building",
"address" : {
"address" : "addressLine1",
"address2" : "addressLine2",
"city" : "city",
"state" : "state",
"postal_code" : "postalCode"
}
}
Response Fields
Path | Type | Description |
---|---|---|
|
|
The building ID |
|
|
The create time |
|
|
The last update time |
|
|
The organization identifier, valid when enabling HIQ feature |
|
|
The building name |
|
|
The parent location ID |
|
|
The building address line1 |
|
|
The building address line2 |
|
|
The building address city |
|
|
The building address state |
|
|
The building address postal/zip code |
HTTP Response
HTTP/1.1 200 OK
RateLimit-Remaining: 7396
Pragma: no-cache
Content-Length: 362
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
{
"id" : 438086664193,
"create_time" : "2023-11-15T13:30:05.000+0000",
"update_time" : "2023-11-15T13:30:05.000+0000",
"org_id" : 0,
"parent_id" : 438086664292,
"name" : "test-building",
"address" : {
"address" : "addressLine1",
"address2" : "addressLine2",
"city" : "city",
"state" : "state",
"postal_code" : "postalCode"
}
}
cURL Request
$ curl 'https://api.extremecloudiq.com/locations/building/438086664193' -i -X PUT \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA1LCJleHAiOjE3MDA2NTk4MDV9.bVkl23D0vnN4gIqCvG9EbjE0-rKQrwan4bw0Ho_BarQ' \
-H 'Content-Type: application/json' \
-d '{
"parent_id" : 438086664292,
"name" : "test-building",
"address" : {
"address" : "addressLine1",
"address2" : "addressLine2",
"city" : "city",
"state" : "state",
"postal_code" : "postalCode"
}
}'
Delete building
DELETE /locations/building/{id}
Path Parameters
Parameter | Description |
---|---|
|
The location ID |
Request parameters
Parameter | Description |
---|---|
|
Force deletion of this building and its descendants recursively |
HTTP Request
DELETE /locations/building/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA2LCJleHAiOjE3MDA2NTk4MDZ9.ylY3Y-XEiyl-wDp_j9WoZ5XxseG412qmrVngSUUpXsc
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
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
RateLimit-Remaining: 7384
cURL Request
$ curl 'https://api.extremecloudiq.com/locations/building/438086664193' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA2LCJleHAiOjE3MDA2NTk4MDZ9.ylY3Y-XEiyl-wDp_j9WoZ5XxseG412qmrVngSUUpXsc' \
-H 'Content-Type: application/json'
List buildings
GET /locations/building
Request parameters
Parameter | Description |
---|---|
|
Page number |
|
Page size |
|
|
|
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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA2LCJleHAiOjE3MDA2NTk4MDZ9.ylY3Y-XEiyl-wDp_j9WoZ5XxseG412qmrVngSUUpXsc
Content-Type: application/json
Response Fields
Path | Type | Description |
---|---|---|
|
|
The current page number |
|
|
The element count of the current page |
|
|
The total page number based on request page size |
|
|
The total element count |
|
|
The building ID |
|
|
The create time |
|
|
The last update time |
|
|
The organization identifier, valid when enabling HIQ feature |
|
|
The building name |
|
|
The parent location ID |
|
|
The building address line1 |
|
|
The building address line2 |
|
|
The building address city |
|
|
The building address state |
|
|
The building address postal/zip code |
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: 480
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: 7384
{
"page" : 1,
"count" : 0,
"total_pages" : 0,
"total_count" : 0,
"data" : [ {
"id" : 438086664193,
"create_time" : "2023-11-15T13:30:06.000+0000",
"update_time" : "2023-11-15T13:30:06.000+0000",
"org_id" : 0,
"parent_id" : 438086664292,
"name" : "test-building",
"address" : {
"address" : "addressLine1",
"address2" : "addressLine2",
"city" : "city",
"state" : "state",
"postal_code" : "postalCode"
}
} ]
}
cURL Request
$ curl 'https://api.extremecloudiq.com/locations/building?page=1&limit=100&name=Test1&order=ASC' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA2LCJleHAiOjE3MDA2NTk4MDZ9.ylY3Y-XEiyl-wDp_j9WoZ5XxseG412qmrVngSUUpXsc' \
-H 'Content-Type: application/json'
Create site
POST /locations/site
Request Fields
Path | Type | Description |
---|---|---|
|
|
The site name |
|
|
The parent site ID |
|
|
The site description |
|
|
The site address line1 |
|
|
The site address line2 |
|
|
The site address city |
|
|
The site address state |
|
|
The site address postal/zip code |
|
|
The country code for the site |
HTTP Request
POST /locations/site HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA2LCJleHAiOjE3MDA2NTk4MDZ9.ylY3Y-XEiyl-wDp_j9WoZ5XxseG412qmrVngSUUpXsc
Content-Type: application/json
Content-Length: 246
{
"parent_id" : 438086664292,
"name" : "test-building",
"address" : {
"address" : "addressLine1",
"address2" : "addressLine2",
"city" : "city",
"state" : "state",
"postal_code" : "postalCode"
},
"country_code" : 62
}
Response Fields
Path | Type | Description |
---|---|---|
|
|
The location ID |
|
|
The create time |
|
|
The last update time |
|
|
The organization identifier, valid when enabling HIQ feature |
|
|
The location name |
|
|
The location unique name |
|
|
The location parent ID |
|
|
The location type |
|
|
The site address line1 |
|
|
The site address line2 |
|
|
The site address city |
|
|
The site address state |
|
|
The site address postal/zip code |
|
|
The country code for the site |
|
|
The site description |
HTTP Response
HTTP/1.1 200 OK
RateLimit-Remaining: 7385
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
Content-Length: 417
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" : "2023-11-15T13:30:06.000+0000",
"update_time" : "2023-11-15T13:30:06.000+0000",
"org_id" : 0,
"parent_id" : 1,
"name" : "test-loc",
"unique_name" : "test-loc",
"type" : "loc",
"address" : {
"address" : "addressLine1",
"address2" : "addressLine2",
"city" : "city",
"state" : "state",
"postal_code" : "postalCode"
},
"country_code" : 92
}
cURL Request
$ curl 'https://api.extremecloudiq.com/locations/site' -i -X POST \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA2LCJleHAiOjE3MDA2NTk4MDZ9.ylY3Y-XEiyl-wDp_j9WoZ5XxseG412qmrVngSUUpXsc' \
-H 'Content-Type: application/json' \
-d '{
"parent_id" : 438086664292,
"name" : "test-building",
"address" : {
"address" : "addressLine1",
"address2" : "addressLine2",
"city" : "city",
"state" : "state",
"postal_code" : "postalCode"
},
"country_code" : 62
}'
Update site
PUT /locations/site/{id}
Path Parameters
Parameter | Description |
---|---|
|
The site ID |
Request Fields
Path | Type | Description |
---|---|---|
|
|
The site name |
|
|
The parent site ID |
|
|
The site address line1 |
|
|
The site address line2 |
|
|
The site address city |
|
|
The site address state |
|
|
The site address postal/zip code |
|
|
The country code for the site |
HTTP Request
PUT /locations/site/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA2LCJleHAiOjE3MDA2NTk4MDZ9.ylY3Y-XEiyl-wDp_j9WoZ5XxseG412qmrVngSUUpXsc
Content-Type: application/json
Content-Length: 246
{
"parent_id" : 438086664292,
"name" : "test-building",
"address" : {
"address" : "addressLine1",
"address2" : "addressLine2",
"city" : "city",
"state" : "state",
"postal_code" : "postalCode"
},
"country_code" : 82
}
Response Fields
Path | Type | Description |
---|---|---|
|
|
The location ID |
|
|
The create time |
|
|
The last update time |
|
|
The organization identifier, valid when enabling HIQ feature |
|
|
The location name |
|
|
The location unique name |
|
|
The parent location ID |
|
|
The location type |
|
|
The site address line1 |
|
|
The site address line2 |
|
|
The site address city |
|
|
The site address state |
|
|
The site address postal/zip code |
|
|
The country code 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
Content-Length: 417
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
RateLimit-Remaining: 7392
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
{
"id" : 438086664193,
"create_time" : "2023-11-15T13:30:06.000+0000",
"update_time" : "2023-11-15T13:30:06.000+0000",
"org_id" : 0,
"parent_id" : 1,
"name" : "test-loc",
"unique_name" : "test-loc",
"type" : "loc",
"address" : {
"address" : "addressLine1",
"address2" : "addressLine2",
"city" : "city",
"state" : "state",
"postal_code" : "postalCode"
},
"country_code" : 92
}
cURL Request
$ curl 'https://api.extremecloudiq.com/locations/site/438086664193' -i -X PUT \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA2LCJleHAiOjE3MDA2NTk4MDZ9.ylY3Y-XEiyl-wDp_j9WoZ5XxseG412qmrVngSUUpXsc' \
-H 'Content-Type: application/json' \
-d '{
"parent_id" : 438086664292,
"name" : "test-building",
"address" : {
"address" : "addressLine1",
"address2" : "addressLine2",
"city" : "city",
"state" : "state",
"postal_code" : "postalCode"
},
"country_code" : 82
}'
Delete site
DELETE /locations/site/{id}
Path Parameters
Parameter | Description |
---|---|
|
The site ID |
Request parameters
Parameter | Description |
---|---|
|
Force deletion of this location and its descendants recursively |
HTTP Request
DELETE /locations/site/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA2LCJleHAiOjE3MDA2NTk4MDZ9.ylY3Y-XEiyl-wDp_j9WoZ5XxseG412qmrVngSUUpXsc
Content-Type: application/json
HTTP Response
HTTP/1.1 200 OK
RateLimit-Remaining: 7386
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/site/438086664193' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA2LCJleHAiOjE3MDA2NTk4MDZ9.ylY3Y-XEiyl-wDp_j9WoZ5XxseG412qmrVngSUUpXsc' \
-H 'Content-Type: application/json'
Get site
Get /locations/site/{id}
Path parameters
Parameter | Description |
---|---|
|
The site ID |
HTTP Request
GET /locations/site/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA2LCJleHAiOjE3MDA2NTk4MDZ9.ylY3Y-XEiyl-wDp_j9WoZ5XxseG412qmrVngSUUpXsc
Content-Type: application/json
Response Fields
Path | Type | Description |
---|---|---|
|
|
The location ID |
|
|
The create time |
|
|
The last update time |
|
|
The organization identifier, valid when enabling HIQ feature |
|
|
The location name |
|
|
The location unique name |
|
|
The parent location ID |
|
|
The location type |
|
|
The site address line1 |
|
|
The site address line2 |
|
|
The site address city |
|
|
The site address state |
|
|
The site address postal/zip code |
|
|
The country code 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
Content-Length: 417
X-Content-Type-Options: nosniff
RateLimit-Remaining: 7390
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" : "2023-11-15T13:30:06.000+0000",
"update_time" : "2023-11-15T13:30:06.000+0000",
"org_id" : 0,
"parent_id" : 1,
"name" : "test-loc",
"unique_name" : "test-loc",
"type" : "loc",
"address" : {
"address" : "addressLine1",
"address2" : "addressLine2",
"city" : "city",
"state" : "state",
"postal_code" : "postalCode"
},
"country_code" : 92
}
cURL Request
$ curl 'https://api.extremecloudiq.com/locations/site/438086664193' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA2LCJleHAiOjE3MDA2NTk4MDZ9.ylY3Y-XEiyl-wDp_j9WoZ5XxseG412qmrVngSUUpXsc' \
-H 'Content-Type: application/json'
List sites
GET /locations/site
Request parameters
Parameter | Description |
---|---|
|
Page number |
|
Page size |
|
|
|
The sort order by name (ascending by default) |
HTTP Request
GET /locations/site?page=1&limit=100&name=Test1&order=ASC HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA1LCJleHAiOjE3MDA2NTk4MDV9.bVkl23D0vnN4gIqCvG9EbjE0-rKQrwan4bw0Ho_BarQ
Host: api.extremecloudiq.com
Content-Type: application/json
Response Fields
Path | Type | Description |
---|---|---|
|
|
The current page number |
|
|
The element count of the current page |
|
|
The total page number based on request page size |
|
|
The total element count |
|
|
The location ID |
|
|
The create time |
|
|
The last update time |
|
|
The organization identifier, valid when enabling HIQ feature |
|
|
The site name |
|
|
The site unique name |
|
|
The site parent ID |
|
|
The site type |
|
|
The site address line1 |
|
|
The site address line2 |
|
|
The site address city |
|
|
The site address state |
|
|
The site address postal/zip code |
|
|
The country code for the site |
|
|
The site description |
HTTP Response
HTTP/1.1 200 OK
RateLimit-Remaining: 7397
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: 541
{
"page" : 1,
"count" : 0,
"total_pages" : 0,
"total_count" : 0,
"data" : [ {
"id" : 438086664193,
"create_time" : "2023-11-15T13:30:05.000+0000",
"update_time" : "2023-11-15T13:30:05.000+0000",
"org_id" : 0,
"parent_id" : 1,
"name" : "test-loc",
"unique_name" : "test-loc",
"type" : "loc",
"address" : {
"address" : "addressLine1",
"address2" : "addressLine2",
"city" : "city",
"state" : "state",
"postal_code" : "postalCode"
},
"country_code" : 92
} ]
}
cURL Request
$ curl 'https://api.extremecloudiq.com/locations/site?page=1&limit=100&name=Test1&order=ASC' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA1LCJleHAiOjE3MDA2NTk4MDV9.bVkl23D0vnN4gIqCvG9EbjE0-rKQrwan4bw0Ho_BarQ' \
-H 'Content-Type: application/json'
Create floor
POST /locations/floor
Request Fields
Path | Type | Description |
---|---|---|
|
|
The floor name |
|
|
The parent building ID |
|
|
The RF environment of floor |
|
|
The floor attenuation of floor |
|
|
The measurement unit of floor |
|
|
The installation height of floor |
|
|
The floor map width |
|
|
The floor map height |
|
|
The floor map name |
HTTP Request
POST /locations/floor HTTP/1.1
Host: api.extremecloudiq.com
Content-Length: 260
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA2LCJleHAiOjE3MDA2NTk4MDZ9.ylY3Y-XEiyl-wDp_j9WoZ5XxseG412qmrVngSUUpXsc
Content-Type: application/json
{
"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 |
---|---|---|
|
|
The floor ID |
|
|
The create time |
|
|
The last update time |
|
|
The organization identifier, valid when enabling HIQ feature |
|
|
The floor name |
|
|
The unique name of floor |
|
|
The parent building ID |
|
|
The RF environment of floor |
|
|
The floor attenuation of floor |
|
|
The measurement unit of floor |
|
|
The installation height of floor |
|
|
The floor map width |
|
|
The floor map height |
|
|
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
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
RateLimit-Remaining: 7394
{
"id" : 438086664193,
"create_time" : "2023-11-15T13:30:06.000+0000",
"update_time" : "2023-11-15T13:30:06.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 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA2LCJleHAiOjE3MDA2NTk4MDZ9.ylY3Y-XEiyl-wDp_j9WoZ5XxseG412qmrVngSUUpXsc' \
-H 'Content-Type: application/json' \
-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
Parameter | Description |
---|---|
|
The floor ID |
Request Fields
Path | Type | Description |
---|---|---|
|
|
The floor name |
|
|
The parent building ID |
|
|
The RF environment of floor |
|
|
The floor attenuation of floor |
|
|
The measurement unit of floor |
|
|
The installation height of floor |
|
|
The floor map width |
|
|
The floor map height |
|
|
The floor map name |
HTTP Request
PUT /locations/floor/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Content-Length: 260
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA2LCJleHAiOjE3MDA2NTk4MDZ9.ylY3Y-XEiyl-wDp_j9WoZ5XxseG412qmrVngSUUpXsc
Content-Type: application/json
{
"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 |
---|---|---|
|
|
The floor ID |
|
|
The create time |
|
|
The last update time |
|
|
The organization identifier, valid when enabling HIQ feature |
|
|
The floor name |
|
|
The unique name of floor |
|
|
The parent building ID |
|
|
The RF environment of floor |
|
|
The floor attenuation of floor |
|
|
The measurement unit of floor |
|
|
The installation height of floor |
|
|
The floor map width |
|
|
The floor map height |
|
|
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: 7389
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" : "2023-11-15T13:30:06.000+0000",
"update_time" : "2023-11-15T13:30:06.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 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA2LCJleHAiOjE3MDA2NTk4MDZ9.ylY3Y-XEiyl-wDp_j9WoZ5XxseG412qmrVngSUUpXsc' \
-H 'Content-Type: application/json' \
-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
Parameter | Description |
---|---|
|
The floor ID |
HTTP Request
DELETE /locations/floor/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA2LCJleHAiOjE3MDA2NTk4MDZ9.ylY3Y-XEiyl-wDp_j9WoZ5XxseG412qmrVngSUUpXsc
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: 7391
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/floor/438086664193' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA2LCJleHAiOjE3MDA2NTk4MDZ9.ylY3Y-XEiyl-wDp_j9WoZ5XxseG412qmrVngSUUpXsc' \
-H 'Content-Type: application/json'
List floors
GET /locations/floor
Request parameters
Parameter | Description |
---|---|
|
Page number |
|
Page size |
|
|
|
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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA1LCJleHAiOjE3MDA2NTk4MDV9.bVkl23D0vnN4gIqCvG9EbjE0-rKQrwan4bw0Ho_BarQ
Host: api.extremecloudiq.com
Content-Type: application/json
Response Fields
Path | Type | Description |
---|---|---|
|
|
The current page number |
|
|
The element count of the current page |
|
|
The total page number based on request page size |
|
|
The total element count |
|
|
The floor ID |
|
|
The create time |
|
|
The last update time |
|
|
The organization identifier, valid when enabling HIQ feature |
|
|
The floor name |
|
|
The unique name of floor |
|
|
The parent building ID |
|
|
The RF environment of floor |
|
|
The floor attenuation of floor |
|
|
The measurement unit of floor |
|
|
The installation height of floor |
|
|
The floor map width |
|
|
The floor map height |
|
|
The floor map name |
HTTP Response
HTTP/1.1 200 OK
RateLimit-Remaining: 7397
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: 551
{
"page" : 1,
"count" : 0,
"total_pages" : 0,
"total_count" : 0,
"data" : [ {
"id" : 438086664193,
"create_time" : "2023-11-15T13:30:05.000+0000",
"update_time" : "2023-11-15T13:30:05.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA1LCJleHAiOjE3MDA2NTk4MDV9.bVkl23D0vnN4gIqCvG9EbjE0-rKQrwan4bw0Ho_BarQ' \
-H 'Content-Type: application/json'
Upload floor plan
POST /locations/floorplan
HTTP Request
POST /locations/floorplan HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA1LCJleHAiOjE3MDA2NTk4MDV9.bVkl23D0vnN4gIqCvG9EbjE0-rKQrwan4bw0Ho_BarQ
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-Remaining: 7398
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/floorplan' -i -X POST \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA1LCJleHAiOjE3MDA2NTk4MDV9.bVkl23D0vnN4gIqCvG9EbjE0-rKQrwan4bw0Ho_BarQ' \
-H 'Content-Type: multipart/form-data' \
-H 'Content-Type: application/json' \
-F 'file=@image.png;type=images/png'
Get location tree
GET /locations/tree
Request Parameters
Parameter | Description |
---|---|
|
The parent location ID, return root locations if parent is null |
|
Whether to return the child locations recursively, default is true.\n" |
HTTP Request
GET /locations/tree?parentId=438086664292&expandChildren=true HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA2LCJleHAiOjE3MDA2NTk4MDZ9.ylY3Y-XEiyl-wDp_j9WoZ5XxseG412qmrVngSUUpXsc
Content-Type: application/json
Response Fields
Path | Type | Description |
---|---|---|
|
|
The location ID. |
|
|
The timestamp when the location was created. |
|
|
The timestamp when the location was last updated. |
|
|
The organization ID. |
|
|
The parent location ID. |
|
|
The location name. |
|
|
The unique location name. |
|
|
The location type. |
|
|
The address for the location. |
|
|
The child locations. |
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Remaining: 7387
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
Content-Length: 1045
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" : "2023-11-15T13:30:06.000+0000",
"update_time" : "2023-11-15T13:30:06.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" : "2023-11-15T13:30:06.000+0000",
"update_time" : "2023-11-15T13:30:06.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" : "2023-11-15T13:30:06.000+0000",
"update_time" : "2023-11-15T13:30:06.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 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDA2LCJleHAiOjE3MDA2NTk4MDZ9.ylY3Y-XEiyl-wDp_j9WoZ5XxseG412qmrVngSUUpXsc' \
-H 'Content-Type: application/json'
Device
List devices
GET /devices
Request Parameters
Parameter | Description |
---|---|
|
Page number |
|
Page size |
|
Location id |
|
The device connect status |
|
The device admin manage status |
|
The device mac addresses |
|
The device serial numbers |
|
The device hostnames |
|
The device sort field |
|
The device sort order |
|
A view is a collection of device fields. |
|
The device fields to return. |
|
The device types |
|
The device empty field to filter. Only return the devices with the selected fields which are null |
|
The location IDs |
|
Config audit status(MATCHED or UNMATCHED) |
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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMyLCJleHAiOjE3MDA2NTk4MzJ9.PJFDLccQLhJJOQ8jpOfA9FJcA-k8FfceNxEmw2YiI4A
Host: api.extremecloudiq.com
Content-Type: application/json
Response Fields
Path | Type | Description |
---|---|---|
|
|
The current page number. |
|
|
The element count of the current page. |
|
|
The total page number based on request page size. |
|
|
The total element count. |
|
|
The device ID. |
|
|
The create time. |
|
|
The last update time. |
|
|
The organization identifier, valid when enabling HIQ feature. |
|
|
The device serial number, valid for all non-HAC devices. |
|
|
The device service tag, valid for all HAC devices. |
|
|
The The device MAC address. |
|
|
The device function, such as AP, Router, Switch, etc. |
|
|
The product type, such as: AP_230, BR_100, NX9600, etc. |
|
|
The device hostname. |
|
|
The device IPv4 address. |
|
|
The device OS software version. |
|
|
The device admin state. |
|
|
The device connection status. |
|
|
The device last connect time |
|
|
The device network policy name |
|
|
The device network policy ID |
|
|
The primary NTP server address of the device |
|
|
The primary DNS server address of the device |
|
|
The subnet mask of the device |
|
|
The default gateway of device |
|
|
The ipv6 address of the device |
|
|
The ipv6 netmask of the device |
|
|
Device is simulated or not |
|
|
The device display version |
|
|
The active clients for the device |
|
|
The device location ID |
|
|
The device detailed location |
|
|
The device LLDP/CDP information |
|
|
The assigned country code for the device |
|
|
The device description |
|
|
The system up time for the device |
|
|
Config audit status(MATCHED or UNMATCHED) |
|
|
The managed application for device) |
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: 2255
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
RateLimit-Remaining: 7282
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" : "2023-11-15T13:30:32.000+0000",
"update_time" : "2023-11-15T13:30:32.000+0000",
"org_id" : 10,
"serial_number" : "30883380851931",
"service_tag" : "",
"mac_address" : "ce7Hs41qSoxs",
"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" : "2023-11-15T13:30:32.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"
}, {
"id" : 2,
"create_time" : "2023-11-15T13:30:32.000+0000",
"update_time" : "2023-11-15T13:30:32.000+0000",
"org_id" : 10,
"serial_number" : "01701937617651",
"service_tag" : "",
"mac_address" : "CR7BFTquKIrH",
"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" : "2023-11-15T13:30:32.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"
} ]
}
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 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMyLCJleHAiOjE3MDA2NTk4MzJ9.PJFDLccQLhJJOQ8jpOfA9FJcA-k8FfceNxEmw2YiI4A' \
-H 'Content-Type: application/json'
List Digital Twin Products
GET /devices/digital-twin
Request Parameters
Parameter | Description |
---|---|
|
Page number |
|
Page size |
|
List by makes or null/empty to list by any makes |
|
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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMwLCJleHAiOjE3MDA2NTk4MzB9.pffBByNH1pfiJXY_GIMBCWDvcImE_OlwcFh3WHO-TxU
Content-Type: application/json
Response Fields
Path | Type | Description |
---|---|---|
|
|
The current page number |
|
|
The element count of the current page |
|
|
The total page number based on request page size |
|
|
The total element count |
|
|
The Digital Twin device make. |
|
|
The Digital Twin device model. |
|
|
The OS Type of the Digital Twin device. |
|
|
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: 7314
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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMwLCJleHAiOjE3MDA2NTk4MzB9.pffBByNH1pfiJXY_GIMBCWDvcImE_OlwcFh3WHO-TxU' \
-H 'Content-Type: application/json'
Get device iBeacon
GET /devices/{id}/ibeacon
Path Parameters
Parameter | Description |
---|---|
|
Device ID |
HTTP Request
GET /devices/438086664193/ibeacon HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMxLCJleHAiOjE3MDA2NTk4MzF9.J8n51fKjGQg74RipcXI-HRsSI7jbWjIHMO5foZDeREg
Content-Type: application/json
Response Fields
Path | Type | Description |
---|---|---|
|
|
Whether to enable the device beacon |
|
|
The device ID |
|
|
Identification of a subset of beacons in a venue. |
|
|
Identification of a beacon in a specific location. |
|
|
The transmission power in dBm. |
|
|
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
Expires: 0
X-Content-Type-Options: nosniff
Content-Length: 129
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
RateLimit-Remaining: 7293
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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMxLCJleHAiOjE3MDA2NTk4MzF9.J8n51fKjGQg74RipcXI-HRsSI7jbWjIHMO5foZDeREg' \
-H 'Content-Type: application/json'
Update device-level iBeacon settings
PUT /devices/ibeacon
HTTP Request
PUT /devices/ibeacon HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMyLCJleHAiOjE3MDA2NTk4MzJ9.PJFDLccQLhJJOQ8jpOfA9FJcA-k8FfceNxEmw2YiI4A
Host: api.extremecloudiq.com
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 |
---|---|---|
|
|
The list of device IDs to update the device level iBeacon settings. |
|
|
Whether to enable the device beacon |
|
|
Identification of a subset of beacons in a venue. |
|
|
Identification of a beacon in a specific location. |
|
|
The transmission power in dBm. |
|
|
Whether to enable monitoring |
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
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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMyLCJleHAiOjE3MDA2NTk4MzJ9.PJFDLccQLhJJOQ8jpOfA9FJcA-k8FfceNxEmw2YiI4A' \
-H 'Content-Type: application/json' \
-d '{
"device_ids" : [ 438086664193 ],
"enabled" : true,
"major" : 1,
"minor" : 1,
"power" : -59,
"enable_monitoring" : true
}'
Send CLI
Send CLI to devices.
POST /devices/:cli
Request Fields
Path | Type | Description |
---|---|---|
|
|
The device ID list. |
|
|
The CLI list. |
HTTP Request
POST /devices/:cli HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMyLCJleHAiOjE3MDA2NTk4MzJ9.PJFDLccQLhJJOQ8jpOfA9FJcA-k8FfceNxEmw2YiI4A
Host: api.extremecloudiq.com
Content-Length: 120
Content-Type: application/json
{
"devices" : {
"ids" : [ 438086664193, 438086664194, 438086664195 ]
},
"clis" : [ "sh version", "sh mgmt" ]
}
Response Fields
Path | Type | Description |
---|---|---|
|
|
device ID → CLI outputs |
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
Content-Length: 32
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
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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMyLCJleHAiOjE3MDA2NTk4MzJ9.PJFDLccQLhJJOQ8jpOfA9FJcA-k8FfceNxEmw2YiI4A' \
-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 |
---|---|---|
|
|
The device ID list. |
HTTP Request
POST /devices/:delete HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMyLCJleHAiOjE3MDA2NTk4MzJ9.PJFDLccQLhJJOQ8jpOfA9FJcA-k8FfceNxEmw2YiI4A
Host: api.extremecloudiq.com
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
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: 7285
cURL Request
$ curl 'https://api.extremecloudiq.com/devices/:delete' -i -X POST \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMyLCJleHAiOjE3MDA2NTk4MzJ9.PJFDLccQLhJJOQ8jpOfA9FJcA-k8FfceNxEmw2YiI4A' \
-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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMwLCJleHAiOjE3MDA2NTk4MzB9.pffBByNH1pfiJXY_GIMBCWDvcImE_OlwcFh3WHO-TxU
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: 7314
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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMwLCJleHAiOjE3MDA2NTk4MzB9.pffBByNH1pfiJXY_GIMBCWDvcImE_OlwcFh3WHO-TxU' \
-H 'Content-Type: application/json' \
-d '{
"ids" : [ 438086664193, 438086664194, 438086664195 ]
}'
Onboard devices
POST /devices/:onboard
Request Fields
Path | Type | Description |
---|---|---|
|
|
The serial numbers of Extreme/Aerohive devices to onboard. |
|
|
The serial numbers of ExtremeXOS (EXOS) devices to onboard. |
|
|
The serial numbers of VSP Operating System Software (VOSS) devices to onboard. |
|
|
The serial number to MAC address mapping. |
|
|
The serial number to service tag mapping of Dell devices to onboard. |
|
|
The Digital Twin devices to onboard. |
HTTP Request
POST /devices/:onboard HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMyLCJleHAiOjE3MDA2NTk4MzJ9.PJFDLccQLhJJOQ8jpOfA9FJcA-k8FfceNxEmw2YiI4A
Host: api.extremecloudiq.com
Content-Length: 450
Content-Type: application/json
{
"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
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
RateLimit-Remaining: 7281
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 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMyLCJleHAiOjE3MDA2NTk4MzJ9.PJFDLccQLhJJOQ8jpOfA9FJcA-k8FfceNxEmw2YiI4A' \
-H 'Content-Type: application/json' \
-d '{
"extreme" : {
"sns" : [ "zzzz-zzz-zzz" ]
},
"exos" : {
"sns" : [ "zzzz-zzz-www" ]
},
"voss" : {
"sns" : [ "zzzz-zzz-www" ]
},
"wing" : {
"sn_to_mac" : {
"serial_num" : "mac_address"
}
},
"dell" : {
"sn_to_st" : {
"serial_num" : "service_tag"
}
},
"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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMwLCJleHAiOjE3MDA2NTk4MzB9.pffBByNH1pfiJXY_GIMBCWDvcImE_OlwcFh3WHO-TxU
Content-Length: 2230
Content-Type: application/json
{
"extreme" : [ {
"serial_number" : "012238339999",
"location" : {
"location_id" : 4312147265229,
"x" : 156.01,
"y" : 889.81,
"latitude" : 10.0,
"longitude" : 23.9
},
"network_policy_id" : 4312147265230,
"hostname" : "SanJose-AP1"
}, {
"serial_number" : "012238338888",
"location" : {
"location_id" : 4312147265330,
"x" : 56.81,
"y" : 100.81,
"latitude" : 20.0,
"longitude" : 33.9
},
"network_policy_id" : 4312147265123,
"hostname" : "SanJose-AP2"
} ],
"exos" : [ {
"serial_number" : "JA0ZZZZG-88801",
"location" : {
"location_id" : 4312147265999,
"x" : 16.01,
"y" : 89.81,
"latitude" : 30.0,
"longitude" : 43.9
},
"network_policy_id" : 4312333265230,
"hostname" : "5420F-48P-4XL-SwitchEngine"
} ],
"voss" : [ {
"serial_number" : "2034G-00113",
"location" : {
"location_id" : 4312147233339,
"x" : 153.01,
"y" : 819.81,
"latitude" : 102.0,
"longitude" : 213.9
},
"network_policy_id" : 4312333265120,
"hostname" : "5520-48W-FabricEngine"
} ],
"wing" : [ {
"serial_number" : "AAAA-BBBB",
"mac_address" : "bc:d0:22:11:aa:bb",
"location" : {
"location_id" : 4312147235539,
"x" : 34.01,
"y" : 23.12,
"latitude" : 202.0,
"longitude" : 63.9
},
"network_policy_id" : 4312333333120,
"hostname" : "WingAP-3321"
} ],
"dell" : [ {
"serial_number" : "XXX-AAAAA",
"service_tag" : "TAG-AC001",
"location" : {
"location_id" : 4312147235555,
"x" : 341.01,
"y" : 232.12,
"latitude" : 112.0,
"longitude" : 632.9
},
"network_policy_id" : 4312333333121,
"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" : 4312147235555,
"x" : 34.01,
"y" : 23.12,
"latitude" : 12.0,
"longitude" : 672.9
},
"network_policy_id" : 4312333333222,
"hostname" : "DT-NAME"
} ],
"unmanaged" : true
}
Request Parameters
Parameter | Description |
---|---|
|
Whether running this request as async or not |
Request Fields
Path | Type | Description |
---|---|---|
|
|
The serial number of Extreme/Aerohive device. |
|
|
The assigned location ID, it must be FLOOR type. |
|
|
The horizontal value in the floor map. |
|
|
The vertical value in the floor map. |
|
|
The latitude in the geography. |
|
|
The longitude in the geography. |
|
|
The assigned network policy id. |
|
|
The assigned device hostname. |
|
|
The serial number of ExtremeXOS (EXOS) device. |
|
|
The assigned location ID, it must be FLOOR type. |
|
|
The horizontal value in the floor map. |
|
|
The vertical value in the floor map. |
|
|
The latitude in the geography. |
|
|
The longitude in the geography. |
|
|
The assigned network policy id. |
|
|
The assigned device hostname. |
|
|
The serial number of VSP Operating System Software (VOSS) device. |
|
|
The assigned location ID, it must be FLOOR type. |
|
|
The horizontal value in the floor map. |
|
|
The vertical value in the floor map. |
|
|
The latitude in the geography. |
|
|
The longitude in the geography. |
|
|
The assigned network policy id. |
|
|
The assigned device hostname. |
|
|
The serial number of ExtremeWireless (WiNG) device. |
|
|
The mac address of ExtremeWireless (WiNG) device. |
|
|
The assigned location ID, it must be FLOOR type. |
|
|
The horizontal value in the floor map. |
|
|
The vertical value in the floor map. |
|
|
The latitude in the geography. |
|
|
The longitude in the geography. |
|
|
The assigned network policy id. |
|
|
The assigned device hostname. |
|
|
The serial number of Dell device. |
|
|
The service tag of Dell device. |
|
|
The assigned location ID, it must be FLOOR type. |
|
|
The horizontal value in the floor map. |
|
|
The vertical value in the floor map. |
|
|
The latitude in the geography. |
|
|
The longitude in the geography. |
|
|
The assigned network policy id. |
|
|
The assigned device hostname. |
|
|
The Digital Twin device make. |
|
|
The Digital Twin device model. |
|
|
The OS Type of the Digital Twin device. |
|
|
The supported OS versions of the Digital Twin device. |
|
|
The assigned location ID, it must be FLOOR type. |
|
|
The horizontal value in the floor map. |
|
|
The vertical value in the floor map. |
|
|
The latitude in the geography. |
|
|
The longitude in the geography. |
|
|
The assigned network policy id. |
|
|
The assigned device hostname. |
|
|
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
RateLimit-Remaining: 7312
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: 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 |
---|---|---|
|
|
The serial number of success device. |
|
|
The id of device. |
|
|
The serial number of failure device. |
|
|
The onboard error code |
cURL Request
$ curl 'https://api.extremecloudiq.com/devices/:advanced-onboard?async=false' -i -X POST \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMwLCJleHAiOjE3MDA2NTk4MzB9.pffBByNH1pfiJXY_GIMBCWDvcImE_OlwcFh3WHO-TxU' \
-H 'Content-Type: application/json' \
-d '{
"extreme" : [ {
"serial_number" : "012238339999",
"location" : {
"location_id" : 4312147265229,
"x" : 156.01,
"y" : 889.81,
"latitude" : 10.0,
"longitude" : 23.9
},
"network_policy_id" : 4312147265230,
"hostname" : "SanJose-AP1"
}, {
"serial_number" : "012238338888",
"location" : {
"location_id" : 4312147265330,
"x" : 56.81,
"y" : 100.81,
"latitude" : 20.0,
"longitude" : 33.9
},
"network_policy_id" : 4312147265123,
"hostname" : "SanJose-AP2"
} ],
"exos" : [ {
"serial_number" : "JA0ZZZZG-88801",
"location" : {
"location_id" : 4312147265999,
"x" : 16.01,
"y" : 89.81,
"latitude" : 30.0,
"longitude" : 43.9
},
"network_policy_id" : 4312333265230,
"hostname" : "5420F-48P-4XL-SwitchEngine"
} ],
"voss" : [ {
"serial_number" : "2034G-00113",
"location" : {
"location_id" : 4312147233339,
"x" : 153.01,
"y" : 819.81,
"latitude" : 102.0,
"longitude" : 213.9
},
"network_policy_id" : 4312333265120,
"hostname" : "5520-48W-FabricEngine"
} ],
"wing" : [ {
"serial_number" : "AAAA-BBBB",
"mac_address" : "bc:d0:22:11:aa:bb",
"location" : {
"location_id" : 4312147235539,
"x" : 34.01,
"y" : 23.12,
"latitude" : 202.0,
"longitude" : 63.9
},
"network_policy_id" : 4312333333120,
"hostname" : "WingAP-3321"
} ],
"dell" : [ {
"serial_number" : "XXX-AAAAA",
"service_tag" : "TAG-AC001",
"location" : {
"location_id" : 4312147235555,
"x" : 341.01,
"y" : 232.12,
"latitude" : 112.0,
"longitude" : 632.9
},
"network_policy_id" : 4312333333121,
"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" : 4312147235555,
"x" : 34.01,
"y" : 23.12,
"latitude" : 12.0,
"longitude" : 672.9
},
"network_policy_id" : 4312333333222,
"hostname" : "DT-NAME"
} ],
"unmanaged" : true
}'
Advanced onboard devices asynchronously
POST /devices/:advanced-onboard
HTTP Request
POST /devices/:advanced-onboard?async=true HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMyLCJleHAiOjE3MDA2NTk4MzJ9.PJFDLccQLhJJOQ8jpOfA9FJcA-k8FfceNxEmw2YiI4A
Host: api.extremecloudiq.com
Content-Length: 2230
Content-Type: application/json
{
"extreme" : [ {
"serial_number" : "012238339999",
"location" : {
"location_id" : 4312147265229,
"x" : 156.01,
"y" : 889.81,
"latitude" : 10.0,
"longitude" : 23.9
},
"network_policy_id" : 4312147265230,
"hostname" : "SanJose-AP1"
}, {
"serial_number" : "012238338888",
"location" : {
"location_id" : 4312147265330,
"x" : 56.81,
"y" : 100.81,
"latitude" : 20.0,
"longitude" : 33.9
},
"network_policy_id" : 4312147265123,
"hostname" : "SanJose-AP2"
} ],
"exos" : [ {
"serial_number" : "JA0ZZZZG-88801",
"location" : {
"location_id" : 4312147265999,
"x" : 16.01,
"y" : 89.81,
"latitude" : 30.0,
"longitude" : 43.9
},
"network_policy_id" : 4312333265230,
"hostname" : "5420F-48P-4XL-SwitchEngine"
} ],
"voss" : [ {
"serial_number" : "2034G-00113",
"location" : {
"location_id" : 4312147233339,
"x" : 153.01,
"y" : 819.81,
"latitude" : 102.0,
"longitude" : 213.9
},
"network_policy_id" : 4312333265120,
"hostname" : "5520-48W-FabricEngine"
} ],
"wing" : [ {
"serial_number" : "AAAA-BBBB",
"mac_address" : "bc:d0:22:11:aa:bb",
"location" : {
"location_id" : 4312147235539,
"x" : 34.01,
"y" : 23.12,
"latitude" : 202.0,
"longitude" : 63.9
},
"network_policy_id" : 4312333333120,
"hostname" : "WingAP-3321"
} ],
"dell" : [ {
"serial_number" : "XXX-AAAAA",
"service_tag" : "TAG-AC001",
"location" : {
"location_id" : 4312147235555,
"x" : 341.01,
"y" : 232.12,
"latitude" : 112.0,
"longitude" : 632.9
},
"network_policy_id" : 4312333333121,
"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" : 4312147235555,
"x" : 34.01,
"y" : 23.12,
"latitude" : 12.0,
"longitude" : 672.9
},
"network_policy_id" : 4312333333222,
"hostname" : "DT-NAME"
} ],
"unmanaged" : true
}
Request Parameters
Parameter | Description |
---|---|
|
Whether running this request as async or not |
Request Fields
Path | Type | Description |
---|---|---|
|
|
The serial number of Extreme/Aerohive device. |
|
|
The assigned location ID, it must be FLOOR type. |
|
|
The horizontal value in the floor map. |
|
|
The vertical value in the floor map. |
|
|
The latitude in the geography. |
|
|
The longitude in the geography. |
|
|
The assigned network policy id. |
|
|
The assigned device hostname. |
|
|
The serial number of ExtremeXOS (EXOS) device. |
|
|
The assigned location ID, it must be FLOOR type. |
|
|
The horizontal value in the floor map. |
|
|
The vertical value in the floor map. |
|
|
The latitude in the geography. |
|
|
The longitude in the geography. |
|
|
The assigned network policy id. |
|
|
The assigned device hostname. |
|
|
The serial number of VSP Operating System Software (VOSS) device. |
|
|
The assigned location ID, it must be FLOOR type. |
|
|
The horizontal value in the floor map. |
|
|
The vertical value in the floor map. |
|
|
The latitude in the geography. |
|
|
The longitude in the geography. |
|
|
The assigned network policy id. |
|
|
The assigned device hostname. |
|
|
The serial number of ExtremeWireless (WiNG) device. |
|
|
The mac address of ExtremeWireless (WiNG) device. |
|
|
The assigned location ID, it must be FLOOR type. |
|
|
The horizontal value in the floor map. |
|
|
The vertical value in the floor map. |
|
|
The latitude in the geography. |
|
|
The longitude in the geography. |
|
|
The assigned network policy id. |
|
|
The assigned device hostname. |
|
|
The serial number of Dell device. |
|
|
The service tag of Dell device. |
|
|
The assigned location ID, it must be FLOOR type. |
|
|
The horizontal value in the floor map. |
|
|
The vertical value in the floor map. |
|
|
The latitude in the geography. |
|
|
The longitude in the geography. |
|
|
The assigned network policy id. |
|
|
The assigned device hostname. |
|
|
The Digital Twin device make. |
|
|
The Digital Twin device model. |
|
|
The OS Type of the Digital Twin device. |
|
|
The supported OS versions of the Digital Twin device. |
|
|
The assigned location ID, it must be FLOOR type. |
|
|
The horizontal value in the floor map. |
|
|
The vertical value in the floor map. |
|
|
The latitude in the geography. |
|
|
The longitude in the geography. |
|
|
The assigned network policy id. |
|
|
The assigned device hostname. |
|
|
Whether to unmanage the devices. |
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: 7284
cURL Request
$ curl 'https://api.extremecloudiq.com/devices/:advanced-onboard?async=true' -i -X POST \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMyLCJleHAiOjE3MDA2NTk4MzJ9.PJFDLccQLhJJOQ8jpOfA9FJcA-k8FfceNxEmw2YiI4A' \
-H 'Content-Type: application/json' \
-d '{
"extreme" : [ {
"serial_number" : "012238339999",
"location" : {
"location_id" : 4312147265229,
"x" : 156.01,
"y" : 889.81,
"latitude" : 10.0,
"longitude" : 23.9
},
"network_policy_id" : 4312147265230,
"hostname" : "SanJose-AP1"
}, {
"serial_number" : "012238338888",
"location" : {
"location_id" : 4312147265330,
"x" : 56.81,
"y" : 100.81,
"latitude" : 20.0,
"longitude" : 33.9
},
"network_policy_id" : 4312147265123,
"hostname" : "SanJose-AP2"
} ],
"exos" : [ {
"serial_number" : "JA0ZZZZG-88801",
"location" : {
"location_id" : 4312147265999,
"x" : 16.01,
"y" : 89.81,
"latitude" : 30.0,
"longitude" : 43.9
},
"network_policy_id" : 4312333265230,
"hostname" : "5420F-48P-4XL-SwitchEngine"
} ],
"voss" : [ {
"serial_number" : "2034G-00113",
"location" : {
"location_id" : 4312147233339,
"x" : 153.01,
"y" : 819.81,
"latitude" : 102.0,
"longitude" : 213.9
},
"network_policy_id" : 4312333265120,
"hostname" : "5520-48W-FabricEngine"
} ],
"wing" : [ {
"serial_number" : "AAAA-BBBB",
"mac_address" : "bc:d0:22:11:aa:bb",
"location" : {
"location_id" : 4312147235539,
"x" : 34.01,
"y" : 23.12,
"latitude" : 202.0,
"longitude" : 63.9
},
"network_policy_id" : 4312333333120,
"hostname" : "WingAP-3321"
} ],
"dell" : [ {
"serial_number" : "XXX-AAAAA",
"service_tag" : "TAG-AC001",
"location" : {
"location_id" : 4312147235555,
"x" : 341.01,
"y" : 232.12,
"latitude" : 112.0,
"longitude" : 632.9
},
"network_policy_id" : 4312333333121,
"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" : 4312147235555,
"x" : 34.01,
"y" : 23.12,
"latitude" : 12.0,
"longitude" : 672.9
},
"network_policy_id" : 4312333333222,
"hostname" : "DT-NAME"
} ],
"unmanaged" : true
}'
Reboot devices
POST /devices/:reboot
Request Fields
Path | Type | Description |
---|---|---|
|
|
The device ID list. |
HTTP Request
POST /devices/:reboot HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMyLCJleHAiOjE3MDA2NTk4MzJ9.PJFDLccQLhJJOQ8jpOfA9FJcA-k8FfceNxEmw2YiI4A
Host: api.extremecloudiq.com
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
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
RateLimit-Remaining: 7285
cURL Request
$ curl 'https://api.extremecloudiq.com/devices/:reboot' -i -X POST \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMyLCJleHAiOjE3MDA2NTk4MzJ9.PJFDLccQLhJJOQ8jpOfA9FJcA-k8FfceNxEmw2YiI4A' \
-H 'Content-Type: application/json' \
-d '{
"ids" : [ 438086664193, 438086664194, 438086664195 ]
}'
Change status to Unmanaged
Change device management status to Unmanaged
status.
POST /devices/:unmanage
Request Fields
Path | Type | Description |
---|---|---|
|
|
The device ID list. |
HTTP Request
POST /devices/:unmanage HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMwLCJleHAiOjE3MDA2NTk4MzB9.pffBByNH1pfiJXY_GIMBCWDvcImE_OlwcFh3WHO-TxU
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
RateLimit-Remaining: 7311
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/:unmanage' -i -X POST \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMwLCJleHAiOjE3MDA2NTk4MzB9.pffBByNH1pfiJXY_GIMBCWDvcImE_OlwcFh3WHO-TxU' \
-H 'Content-Type: application/json' \
-d '{
"ids" : [ 438086664193, 438086664194, 438086664195 ]
}'
Get one device detail
GET /devices/{id}
Path parameters
Parameter | Description |
---|---|
|
Device ID |
Request Parameters
Parameter | Description |
---|---|
|
A view is a collection of device fields. |
|
The device fields to return. |
HTTP Request
GET /devices/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMxLCJleHAiOjE3MDA2NTk4MzF9.J8n51fKjGQg74RipcXI-HRsSI7jbWjIHMO5foZDeREg
Content-Type: application/json
Response Fields
Path | Type | Description |
---|---|---|
|
|
The device ID. |
|
|
The create time. |
|
|
The last update time. |
|
|
The organization identifier, valid when enabling HIQ feature. |
|
|
The device serial number, valid for all non-HAC devices. |
|
|
The device service tag, valid for all HAC devices. |
|
|
The The device MAC address. |
|
|
The device function, such as AP, Router, Switch, etc. |
|
|
The product type, such as: AP_230, BR_100, NX9600, etc. |
|
|
The device hostname. |
|
|
The device IPv4 address. |
|
|
The device OS software version. |
|
|
The device admin state. |
|
|
The device connection status. |
|
|
The device last connect time. |
|
|
The device network policy name |
|
|
The device network policy ID |
|
|
The primary NTP server address of the device |
|
|
The primary DNS server address of the device |
|
|
The subnet mask of the device |
|
|
The default gateway of device |
|
|
The ipv6 address of the device |
|
|
The ipv6 netmask of the device |
|
|
Device is simulated or not |
|
|
The device display version |
|
|
The active clients for the device |
|
|
The device location ID |
|
|
The device detailed location |
|
|
The device LLDP/CDP information |
|
|
The device assigned country code |
|
|
The device description |
|
|
Config audit status(MATCHED or UNMATCHED) |
|
|
The managed application for the device |
HTTP Response
HTTP/1.1 200 OK
RateLimit-Remaining: 7298
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: 982
{
"id" : 1,
"create_time" : "2023-11-15T13:30:31.000+0000",
"update_time" : "2023-11-15T13:30:31.000+0000",
"org_id" : 10,
"serial_number" : "28097547929039",
"service_tag" : "",
"mac_address" : "lpU4p5UKg34o",
"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" : "2023-11-15T13:30:31.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" : ""
}
cURL Request
$ curl 'https://api.extremecloudiq.com/devices/438086664193' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMxLCJleHAiOjE3MDA2NTk4MzF9.J8n51fKjGQg74RipcXI-HRsSI7jbWjIHMO5foZDeREg' \
-H 'Content-Type: application/json'
Delete device
Delete one device.
DELETE /devices/{id}
Path parameters
Parameter | Description |
---|---|
|
Device ID |
HTTP Request
DELETE /devices/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMxLCJleHAiOjE3MDA2NTk4MzF9.J8n51fKjGQg74RipcXI-HRsSI7jbWjIHMO5foZDeREg
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: 7291
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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMxLCJleHAiOjE3MDA2NTk4MzF9.J8n51fKjGQg74RipcXI-HRsSI7jbWjIHMO5foZDeREg' \
-H 'Content-Type: application/json'
Send CLI to one device
Send CLI to one device.
POST /devices/{id}/:cli
Path parameters
Parameter | Description |
---|---|
|
Device ID |
Request Fields
Path | Type | Description |
---|---|---|
|
|
The request CLIs |
HTTP Request
POST /devices/438086664193/:cli HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMxLCJleHAiOjE3MDA2NTk4MzF9.J8n51fKjGQg74RipcXI-HRsSI7jbWjIHMO5foZDeREg
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
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
{
"device_cli_outputs" : { }
}
cURL Request
$ curl 'https://api.extremecloudiq.com/devices/438086664193/:cli' -i -X POST \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMxLCJleHAiOjE3MDA2NTk4MzF9.J8n51fKjGQg74RipcXI-HRsSI7jbWjIHMO5foZDeREg' \
-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
Parameter | Description |
---|---|
|
Device ID |
HTTP Request
POST /devices/438086664193/:manage HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMyLCJleHAiOjE3MDA2NTk4MzJ9.PJFDLccQLhJJOQ8jpOfA9FJcA-k8FfceNxEmw2YiI4A
Host: api.extremecloudiq.com
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/:manage' -i -X POST \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMyLCJleHAiOjE3MDA2NTk4MzJ9.PJFDLccQLhJJOQ8jpOfA9FJcA-k8FfceNxEmw2YiI4A' \
-H 'Content-Type: application/json'
Reboot one device
POST /devices/{id}/:reboot
Path parameters
Parameter | Description |
---|---|
|
Device ID |
HTTP Request
POST /devices/438086664193/:reboot HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMwLCJleHAiOjE3MDA2NTk4MzB9.pffBByNH1pfiJXY_GIMBCWDvcImE_OlwcFh3WHO-TxU
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: 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/438086664193/:reboot' -i -X POST \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMwLCJleHAiOjE3MDA2NTk4MzB9.pffBByNH1pfiJXY_GIMBCWDvcImE_OlwcFh3WHO-TxU' \
-H 'Content-Type: application/json'
Change status to Unmanaged for one device
Change device management status to Unmanaged
status.
POST /devices/{id}/:unmanage
Path parameters
Parameter | Description |
---|---|
|
Device ID |
HTTP Request
POST /devices/438086664193/:unmanage HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMxLCJleHAiOjE3MDA2NTk4MzF9.J8n51fKjGQg74RipcXI-HRsSI7jbWjIHMO5foZDeREg
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: 7303
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/:unmanage' -i -X POST \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMxLCJleHAiOjE3MDA2NTk4MzF9.J8n51fKjGQg74RipcXI-HRsSI7jbWjIHMO5foZDeREg' \
-H 'Content-Type: application/json'
Get device alarms for one device
GET /devices/{id}/alarms
Path parameters
Parameter | Description |
---|---|
|
Device ID |
Request Parameters
Parameter | Description |
---|---|
|
Page number |
|
Page size |
|
The start time for query device alarms |
|
The end time for query device alarms |
HTTP Request
GET /devices/438086664193/alarms?startTime=1&endTime=2 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDI5LCJleHAiOjE3MDA2NTk4Mjl9.DavsuaoS9K8Mflb7dcok-nr4CoHynZiAmVHKxADIzFQ
Content-Type: application/json
Response Fields
Path | Type | Description |
---|---|---|
|
|
The current page number |
|
|
The element count of the current page |
|
|
The total page number based on request page size |
|
|
The total element count |
|
|
The entity ID |
|
|
The timestamp alarm created |
|
|
The severity of the alarm |
|
|
The category of the alarm |
|
|
The device mac of the alarm |
|
|
The client mac of the alarm |
|
|
The alarm description |
HTTP Response
HTTP/1.1 200 OK
RateLimit-Remaining: 7320
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Length: 715
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" : 3,
"total_pages" : 3,
"total_count" : 8,
"data" : [ {
"entity_id" : 1,
"timestamp" : 1700055029000,
"severity" : "Major",
"category" : "test-cat-1",
"device_mac" : "JQCDAAOKLMPR",
"client_mac" : "",
"description" : "test-desc1"
}, {
"entity_id" : 2,
"timestamp" : 1700055029000,
"severity" : "Major",
"category" : "test-cat-2",
"device_mac" : "TXPDELFAUQZS",
"client_mac" : "",
"description" : "test-desc2"
}, {
"entity_id" : 3,
"timestamp" : 1700055029000,
"severity" : "Major",
"category" : "test-cat-3",
"device_mac" : "JVJRZHELXMNL",
"client_mac" : "",
"description" : "test-desc3"
} ]
}
cURL Request
$ curl 'https://api.extremecloudiq.com/devices/438086664193/alarms?startTime=1&endTime=2' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDI5LCJleHAiOjE3MDA2NTk4Mjl9.DavsuaoS9K8Mflb7dcok-nr4CoHynZiAmVHKxADIzFQ' \
-H 'Content-Type: application/json'
Get device CPU/memory usage for one device
GET /devices/{id}/history/cpu-mem
Path parameters
Parameter | Description |
---|---|
|
Device ID |
Request Parameters
Parameter | Description |
---|---|
|
The start time for cpu and memory aggregate |
|
The end time for cpu and memory aggregate |
|
The interval for cpu and memory aggregate |
HTTP Request
GET /devices/438086664193/history/cpu-mem?startTime=1&endTime=2&interval=1 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMwLCJleHAiOjE3MDA2NTk4MzB9.pffBByNH1pfiJXY_GIMBCWDvcImE_OlwcFh3WHO-TxU
Content-Type: application/json
Response Fields
Path | Type | Description |
---|---|---|
|
|
The average cpu |
|
|
The average memory |
|
|
The timestamp for data aggregate |
HTTP Response
HTTP/1.1 200 OK
Content-Length: 162
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: 7309
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
[ {
"average_cpu" : 1,
"average_memory" : 1,
"timestamp" : 1700055030000
}, {
"average_cpu" : 2,
"average_memory" : 2,
"timestamp" : 1700055030000
} ]
cURL Request
$ curl 'https://api.extremecloudiq.com/devices/438086664193/history/cpu-mem?startTime=1&endTime=2&interval=1' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMwLCJleHAiOjE3MDA2NTk4MzB9.pffBByNH1pfiJXY_GIMBCWDvcImE_OlwcFh3WHO-TxU' \
-H 'Content-Type: application/json'
Change hostname for one device
PUT /devices/{id}/hostname
Path parameters
Parameter | Description |
---|---|
|
Device ID |
Request Parameters
Parameter | Description |
---|---|
|
The new hostname |
HTTP Request
PUT /devices/438086664193/hostname HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMxLCJleHAiOjE3MDA2NTk4MzF9.J8n51fKjGQg74RipcXI-HRsSI7jbWjIHMO5foZDeREg
Content-Type: application/json
hostname=hostname_001
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: 7290
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/hostname' -i -X PUT \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMxLCJleHAiOjE3MDA2NTk4MzF9.J8n51fKjGQg74RipcXI-HRsSI7jbWjIHMO5foZDeREg' \
-H 'Content-Type: application/json' \
-d 'hostname=hostname_001'
Get location for one device
GET /devices/{id}/location
Path parameters
Parameter | Description |
---|---|
|
Device ID |
HTTP Request
GET /devices/438086664193/location HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMyLCJleHAiOjE3MDA2NTk4MzJ9.PJFDLccQLhJJOQ8jpOfA9FJcA-k8FfceNxEmw2YiI4A
Host: api.extremecloudiq.com
Content-Type: application/json
Response Fields
Path | Type | Description |
---|---|---|
|
|
The assigned location ID. |
|
|
The timestamp when the device assigned to the location. |
|
|
The timestamp when the location info was last updated. |
|
|
The organization ID. |
|
|
The parent location ID. |
|
|
The location name. |
|
|
The unique location name. |
|
|
The address for the location. |
|
|
The address for the location. |
|
|
The horizontal value in the floor map. |
|
|
The vertical value in the floor map. |
|
|
The latitude in the geography. |
|
|
The longitude in the geography. |
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
Content-Length: 395
RateLimit-Limit: 7500;w=3600
RateLimit-Remaining: 7289
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
{
"location_id" : 438086664193,
"create_time" : "2023-11-15T13:30:32.000+0000",
"update_time" : "2023-11-15T13:30:32.000+0000",
"org_id" : 0,
"parent_id" : 0,
"location_name" : "1st floor",
"location_unique_name" : "Location_001_floor",
"location_type" : "Standard",
"location_address" : "Location address",
"x" : 101.0,
"y" : 0.0,
"latitude" : 0.0,
"longitude" : 0.0
}
cURL Request
$ curl 'https://api.extremecloudiq.com/devices/438086664193/location' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMyLCJleHAiOjE3MDA2NTk4MzJ9.PJFDLccQLhJJOQ8jpOfA9FJcA-k8FfceNxEmw2YiI4A' \
-H 'Content-Type: application/json'
Assign location to one device
PUT /devices/{id}/location
Path parameters
Parameter | Description |
---|---|
|
Device ID |
Request Fields
Path | Type | Description |
---|---|---|
|
|
The assigned location ID. |
|
|
The horizontal value in the floor map. |
|
|
The vertical value in the floor map. |
|
|
The vertical value in the floor map. |
|
|
The longitude in the geography. |
HTTP Request
PUT /devices/438086664193/location HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDI5LCJleHAiOjE3MDA2NTk4Mjl9.DavsuaoS9K8Mflb7dcok-nr4CoHynZiAmVHKxADIzFQ
Content-Length: 90
Content-Type: application/json
{
"location_id" : 1,
"x" : 0.0,
"y" : 0.0,
"latitude" : 0.0,
"longitude" : 0.0
}
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
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/location' -i -X PUT \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDI5LCJleHAiOjE3MDA2NTk4Mjl9.DavsuaoS9K8Mflb7dcok-nr4CoHynZiAmVHKxADIzFQ' \
-H 'Content-Type: application/json' \
-d '{
"location_id" : 1,
"x" : 0.0,
"y" : 0.0,
"latitude" : 0.0,
"longitude" : 0.0
}'
Revoke location for one device
DELETE /devices/{id}/location
Path parameters
Parameter | Description |
---|---|
|
Device ID |
HTTP Request
DELETE /devices/438086664193/location HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMxLCJleHAiOjE3MDA2NTk4MzF9.J8n51fKjGQg74RipcXI-HRsSI7jbWjIHMO5foZDeREg
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
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
RateLimit-Remaining: 7294
cURL Request
$ curl 'https://api.extremecloudiq.com/devices/438086664193/location' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMxLCJleHAiOjE3MDA2NTk4MzF9.J8n51fKjGQg74RipcXI-HRsSI7jbWjIHMO5foZDeREg' \
-H 'Content-Type: application/json'
Get network policy for one device
GET /devices/{id}/network-policy
Path parameters
Parameter | Description |
---|---|
|
Device ID |
HTTP Request
GET /devices/438086664193/network-policy HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMwLCJleHAiOjE3MDA2NTk4MzB9.pffBByNH1pfiJXY_GIMBCWDvcImE_OlwcFh3WHO-TxU
Content-Type: application/json
Response Fields
Path | Type | Description |
---|---|---|
|
|
The network policy ID. |
|
|
The timestamp when the network policy was created. |
|
|
The timestamp when the network policy was last updated. |
|
|
The Organization ID. |
|
|
The network policy name. |
|
|
The network policy description. |
|
|
The network policy type. |
|
|
Whether it is a predefined or not. |
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-Length: 349
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" : "2023-11-15T13:30:30.000+0000",
"update_time" : "2023-11-15T13:30:30.000+0000",
"org_id" : 0,
"name" : "Policy_001",
"description" : "The description of network policy",
"predefined" : false,
"type" : "N_E_T_W_O_R_K__P_O_L_I_C_Y__T_Y_P_E__N_E_T_W_O_R_K__A_C_C_E_S_S__A_N_D__S_W_I_T_C_H_I_N_G"
}
cURL Request
$ curl 'https://api.extremecloudiq.com/devices/438086664193/network-policy' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMwLCJleHAiOjE3MDA2NTk4MzB9.pffBByNH1pfiJXY_GIMBCWDvcImE_OlwcFh3WHO-TxU' \
-H 'Content-Type: application/json'
Assign network policy to one device
PUT /devices/{id}/network-policy
Path parameters
Parameter | Description |
---|---|
|
Device ID |
Request Parameters
Parameter | Description |
---|---|
|
The network policy ID to assign |
HTTP Request
PUT /devices/438086664193/network-policy HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMwLCJleHAiOjE3MDA2NTk4MzB9.pffBByNH1pfiJXY_GIMBCWDvcImE_OlwcFh3WHO-TxU
Content-Type: application/json
networkPolicyId=438086664194
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Remaining: 7310
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/network-policy' -i -X PUT \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMwLCJleHAiOjE3MDA2NTk4MzB9.pffBByNH1pfiJXY_GIMBCWDvcImE_OlwcFh3WHO-TxU' \
-H 'Content-Type: application/json' \
-d 'networkPolicyId=438086664194'
Revoke network policy for one device
DELETE /devices/{id}/network-policy
Path parameters
Parameter | Description |
---|---|
|
Device ID |
HTTP Request
DELETE /devices/438086664193/network-policy HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMyLCJleHAiOjE3MDA2NTk4MzJ9.PJFDLccQLhJJOQ8jpOfA9FJcA-k8FfceNxEmw2YiI4A
Host: api.extremecloudiq.com
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: 7280
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/network-policy' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMyLCJleHAiOjE3MDA2NTk4MzJ9.PJFDLccQLhJJOQ8jpOfA9FJcA-k8FfceNxEmw2YiI4A' \
-H 'Content-Type: application/json'
Device level SSID override
POST /devices/{id}/ssid/:override
Path parameters
Parameter | Description |
---|---|
|
Device ID |
Request Fields
Path | Type | Description |
---|---|---|
|
|
The ssid ID to override. |
|
|
The broadcast ssid name to override. Can only override if the SSID profile is OPEN or PSK mode. |
|
|
The passphrase to override. Can only override if the SSID profile is in PSK mode. |
HTTP Request
POST /devices/438086664193/ssid/:override HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDI5LCJleHAiOjE3MDA2NTk4Mjl9.DavsuaoS9K8Mflb7dcok-nr4CoHynZiAmVHKxADIzFQ
Content-Type: application/json
Content-Length: 68
{
"ssid_id" : 1,
"ssid" : "ssid0",
"passphrase" : "aerohive"
}
HTTP Response
HTTP/1.1 200 OK
RateLimit-Remaining: 7320
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/ssid/:override' -i -X POST \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDI5LCJleHAiOjE3MDA2NTk4Mjl9.DavsuaoS9K8Mflb7dcok-nr4CoHynZiAmVHKxADIzFQ' \
-H 'Content-Type: application/json' \
-d '{
"ssid_id" : 1,
"ssid" : "ssid0",
"passphrase" : "aerohive"
}'
Get device level SSID status
Get device level SSID status on each wifi interface
GET /devices/{id}/ssid/status
Path parameters
Parameter | Description |
---|---|
|
The device ID |
HTTP Request
GET /devices/438086664193/ssid/status HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMyLCJleHAiOjE3MDA2NTk4MzJ9.PJFDLccQLhJJOQ8jpOfA9FJcA-k8FfceNxEmw2YiI4A
Host: api.extremecloudiq.com
Content-Type: application/json
Response Fields
Path | Type | Description |
---|---|---|
|
|
The SSID is enabled or not on wifi0 interface |
|
|
The SSID is enabled or not on wifi1 interface |
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-Length: 72
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
{
"1" : {
"wifi0_enabled" : true,
"wifi1_enabled" : true
}
}
cURL Request
$ curl 'https://api.extremecloudiq.com/devices/438086664193/ssid/status' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMyLCJleHAiOjE3MDA2NTk4MzJ9.PJFDLccQLhJJOQ8jpOfA9FJcA-k8FfceNxEmw2YiI4A' \
-H 'Content-Type: application/json'
Change device level SSID status
Change device level SSID status on each wifi interface
POST /devices/{id}/ssid/status/:change
Path parameters
Parameter | Description |
---|---|
|
Device ID |
Request Fields
Path | Type | Description |
---|---|---|
|
|
The SSID IDs to disable. If no SSID ID is given, no action will happen |
|
|
The wifi interfaces to disable the SSID. Example: wifi0. If both wifi0 or wifi1 are given, the SSIDs given in ssid_ids list will be disabled or enabled on both wifi interfaces |
|
|
Boolean flag to indicate whether the SSIDs should be disabled or enabled |
HTTP Request
POST /devices/438086664193/ssid/status/:change HTTP/1.1
Host: api.extremecloudiq.com
Content-Length: 88
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMwLCJleHAiOjE3MDA2NTk4MzB9.pffBByNH1pfiJXY_GIMBCWDvcImE_OlwcFh3WHO-TxU
Content-Type: application/json
{
"ssid_ids" : [ 1, 2, 3 ],
"if_names" : [ "WIFI0", "WIFI1" ],
"enabled" : false
}
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: 7307
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/ssid/status/:change' -i -X POST \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMwLCJleHAiOjE3MDA2NTk4MzB9.pffBByNH1pfiJXY_GIMBCWDvcImE_OlwcFh3WHO-TxU' \
-H 'Content-Type: application/json' \
-d '{
"ssid_ids" : [ 1, 2, 3 ],
"if_names" : [ "WIFI0", "WIFI1" ],
"enabled" : false
}'
Assign location to multiple devices
POST /devices/location/:assgin
Request Fields
Path | Type | Description |
---|---|---|
|
|
The devices filter |
|
|
The device ID list. |
|
|
The Device location assignment |
|
|
The assigned location ID. |
|
|
The horizontal value in the floor map. |
|
|
The vertical value in the floor map. |
|
|
The vertical value in the floor map. |
|
|
The longitude in the geography. |
HTTP Request
POST /devices/location/:assign HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMwLCJleHAiOjE3MDA2NTk4MzB9.pffBByNH1pfiJXY_GIMBCWDvcImE_OlwcFh3WHO-TxU
Content-Type: application/json
Content-Length: 206
{
"devices" : {
"ids" : [ 438086664193, 438086664194, 438086664195 ]
},
"device_location" : {
"location_id" : 1,
"x" : 0.0,
"y" : 0.0,
"latitude" : 0.0,
"longitude" : 0.0
}
}
HTTP Response
HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
RateLimit-Remaining: 7316
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/location/:assign' -i -X POST \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMwLCJleHAiOjE3MDA2NTk4MzB9.pffBByNH1pfiJXY_GIMBCWDvcImE_OlwcFh3WHO-TxU' \
-H 'Content-Type: application/json' \
-d '{
"devices" : {
"ids" : [ 438086664193, 438086664194, 438086664195 ]
},
"device_location" : {
"location_id" : 1,
"x" : 0.0,
"y" : 0.0,
"latitude" : 0.0,
"longitude" : 0.0
}
}'
Query location for multiple devices
POST /devices/location/:query
Request Fields
Path | Type | Description |
---|---|---|
|
|
The device ID list. |
HTTP Request
POST /devices/location/:query HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMwLCJleHAiOjE3MDA2NTk4MzB9.pffBByNH1pfiJXY_GIMBCWDvcImE_OlwcFh3WHO-TxU
Content-Type: application/json
Content-Length: 58
{
"ids" : [ 438086664193, 438086664194, 438086664195 ]
}
Response Fields
Path | Type | Description |
---|---|---|
|
|
The assigned location ID. |
|
|
The timestamp when the device assigned to the location. |
|
|
The timestamp when the location info was last updated. |
|
|
The organization ID. |
|
|
The parent location ID. |
|
|
The location name. |
|
|
The unique location name. |
|
|
The address for the location. |
|
|
The address for the location. |
|
|
The horizontal value in the floor map. |
|
|
The vertical value in the floor map. |
|
|
The latitude in the geography. |
|
|
The longitude in the geography. |
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: 446
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
{
"438086664193" : {
"location_id" : 438086664193,
"create_time" : "2023-11-15T13:30:30.000+0000",
"update_time" : "2023-11-15T13:30:30.000+0000",
"org_id" : 0,
"parent_id" : 0,
"location_name" : "1st floor",
"location_unique_name" : "Location_001_floor",
"location_type" : "Standard",
"location_address" : "Location address",
"x" : 101.0,
"y" : 0.0,
"latitude" : 0.0,
"longitude" : 0.0
}
}
cURL Request
$ curl 'https://api.extremecloudiq.com/devices/location/:query' -i -X POST \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMwLCJleHAiOjE3MDA2NTk4MzB9.pffBByNH1pfiJXY_GIMBCWDvcImE_OlwcFh3WHO-TxU' \
-H 'Content-Type: application/json' \
-d '{
"ids" : [ 438086664193, 438086664194, 438086664195 ]
}'
Revoke location for multiple devices
POST /devices/location/:revoke
Request Fields
Path | Type | Description |
---|---|---|
|
|
The device ID list. |
HTTP Request
POST /devices/location/:revoke HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMwLCJleHAiOjE3MDA2NTk4MzB9.pffBByNH1pfiJXY_GIMBCWDvcImE_OlwcFh3WHO-TxU
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: 7306
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/location/:revoke' -i -X POST \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMwLCJleHAiOjE3MDA2NTk4MzB9.pffBByNH1pfiJXY_GIMBCWDvcImE_OlwcFh3WHO-TxU' \
-H 'Content-Type: application/json' \
-d '{
"ids" : [ 438086664193, 438086664194, 438086664195 ]
}'
Assign network policy to multiple devices
POST /devices/network-policy/:assgin
Request Fields
Path | Type | Description |
---|---|---|
|
|
The devices filter |
|
|
The device ID list. |
|
|
The assigned network policy ID |
HTTP Request
POST /devices/network-policy/:assign HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMxLCJleHAiOjE3MDA2NTk4MzF9.J8n51fKjGQg74RipcXI-HRsSI7jbWjIHMO5foZDeREg
Content-Type: application/json
Content-Length: 107
{
"devices" : {
"ids" : [ 438086664193, 438086664194, 438086664195 ]
},
"network_policy_id" : 1
}
HTTP Response
HTTP/1.1 200 OK
RateLimit-Remaining: 7297
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/network-policy/:assign' -i -X POST \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMxLCJleHAiOjE3MDA2NTk4MzF9.J8n51fKjGQg74RipcXI-HRsSI7jbWjIHMO5foZDeREg' \
-H 'Content-Type: application/json' \
-d '{
"devices" : {
"ids" : [ 438086664193, 438086664194, 438086664195 ]
},
"network_policy_id" : 1
}'
Query network policy for multiple devices
POST /devices/network-policy/:query
Request Fields
Path | Type | Description |
---|---|---|
|
|
The device ID list. |
HTTP Request
POST /devices/network-policy/:query HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMwLCJleHAiOjE3MDA2NTk4MzB9.pffBByNH1pfiJXY_GIMBCWDvcImE_OlwcFh3WHO-TxU
Content-Type: application/json
Content-Length: 58
{
"ids" : [ 438086664193, 438086664194, 438086664195 ]
}
Response Fields
Path | Type | Description |
---|---|---|
|
|
The assigned location ID. |
|
|
The timestamp when the device assigned to the location. |
|
|
The timestamp when the location info was last updated. |
|
|
The organization ID. |
|
|
The parent location ID. |
|
|
The location name. |
|
|
The unique location name. |
|
|
The address for the location. |
|
|
The address for the location. |
|
|
The horizontal value in the floor map. |
|
|
The vertical value in the floor map. |
|
|
The latitude in the geography. |
|
|
The longitude in the geography. |
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: 446
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
{
"438086664193" : {
"location_id" : 438086664193,
"create_time" : "2023-11-15T13:30:30.000+0000",
"update_time" : "2023-11-15T13:30:30.000+0000",
"org_id" : 0,
"parent_id" : 0,
"location_name" : "1st floor",
"location_unique_name" : "Location_001_floor",
"location_type" : "Standard",
"location_address" : "Location address",
"x" : 101.0,
"y" : 0.0,
"latitude" : 0.0,
"longitude" : 0.0
}
}
cURL Request
$ curl 'https://api.extremecloudiq.com/devices/location/:query' -i -X POST \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMwLCJleHAiOjE3MDA2NTk4MzB9.pffBByNH1pfiJXY_GIMBCWDvcImE_OlwcFh3WHO-TxU' \
-H 'Content-Type: application/json' \
-d '{
"ids" : [ 438086664193, 438086664194, 438086664195 ]
}'
Revoke network policy for multiple devices
POST /devices/network-policy/:revoke
Request Fields
Path | Type | Description |
---|---|---|
|
|
The device ID list. |
HTTP Request
POST /devices/network-policy/:revoke HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjb3BpbG90LWNvbm5lY3Rpdml0eS13aXJlZDpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWxlc3M6ciIsImNvcGlsb3QtYW5vbWFsaWVzOnIiLCJsaWNlbnNlcyIsImxpY2Vuc2VzOnIiLCJjb3BpbG90LWFzc3VyYW5jZS1zY2FuczpyIiwicGFja2V0LWNhcHR1cmUiLCJwYWNrZXQtY2FwdHVyZTpyIiwiY291bnRyeSIsImNvdW50cnk6ciJdLCJjdXN0b21lcl9pZCI6MSwiY3VzdG9tZXJfbW9kZSI6MCwiaGlxX2VuYWJsZWQiOnRydWUsIm9yZ19pZCI6MCwicXVvdGEiOiI3NTAwO3c9MzYwMCIsInNoYXJkIjoiVVMiLCJpc3MiOiJhcGkuZXh0cmVtZWNsb3VkaXEuY29tIiwiaWF0IjoxNzAwMDU1MDMyLCJleHAiOjE3MDA2NTk4MzJ9.PJFDLccQLhJJOQ8jpOfA9FJcA-k8FfceNxEmw2YiI4A
Host: api.extremecloudiq.com
Content-Type: application/json
Content-Length: 58
{
"ids" : [ 438086664193, 438086664194, 438086664195 ]
}
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
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/network-policy/:revoke' -i -X POST \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJ