ExtremeCloud™ IQ API Reference

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

Path	Type	Description
`username`	`String`	The login username
`password`	`String`	The login password

username

String

The login username

password

String

The login password

HTTP Request

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

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

cURL Request

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

Response Fields

Path Type Description

Path	Type	Description
`access_token`	`String`	The access token with JWT format issued by ExtremeCloud IQ
`token_type`	`String`	The type of token, only supports "Bearer" currently
`expires_in`	`Number`	The lifetime in seconds of the access token

access_token

String

The access token with JWT format issued by ExtremeCloud IQ

token_type

String

The type of token, only supports "Bearer" currently

expires_in

Number

The lifetime in seconds of the access token

Successful Login Response

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

{
  "access_token" : "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2MiwiZXhwIjoxNzEyNzc4OTYyfQ.PrZZq6DmGuF9BAskvTklz9vjTEK4PfJIXmEiBFJHdTA",
  "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" : "255211eecf874a7caec93c83d7f4eb22",
  "error_message" : "Access Denied!!!"
}

Logout

POST /logout

Request Fields

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

HTTP Request

POST /logout HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2MiwiZXhwIjoxNzEyNzc4OTYyfQ.PrZZq6DmGuF9BAskvTklz9vjTEK4PfJIXmEiBFJHdTA
Host: api.extremecloudiq.com
Content-Type: application/json

cURL Request

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

Response Fields

No response field will be returned.

Successful Logout Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
RateLimit-Remaining: 7318
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" : "9a7eb8bc5e1e424eb2c33fb1a40a08cd"
}

Authorization

Generate API token

POST /auth/apitoken

Request Fields

Path Type Description

Path	Type	Description
`expire_time`	`Number`	The token expire time, format is the number of seconds from epoch of 1970-01-01T00:00:00Z. If null means no expiration, the minimum value is current time plus 300 seconds.
`permissions`	`Array`	The permission list.
`description`	`String`	The token description

expire_time

Number

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

permissions

Array

The permission list.

description

String

The token description

HTTP Request

POST /auth/apitoken HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Content-Length: 118
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3NiwiZXhwIjoxNzEyNzc4OTc2fQ.0Kal6qLvyzv9Mh1pjMnZyfvZBetkTFJ7GX7fBgYJ--s

{
  "expire_time" : 1712177776,
  "description" : "API Token for account read.",
  "permissions" : [ "write*:auth" ]
}

Response Fields

Path Type Description

Path	Type	Description
`access_token`	`String`	The API access token.
`create_time`	`String`	The create timestamp.
`expire_time`	`String`	The expire timestamp.
`creator_id`	`Number`	The user ID who created the API token.
`customer_id`	`Number`	The customer ID who owns the API token.
`description`	`String`	The description for the API token.
`permissions`	`Array`	The permissions for the API token.

access_token

String

The API access token.

create_time

String

The create timestamp.

expire_time

String

The expire timestamp.

creator_id

Number

The user ID who created the API token.

customer_id

Number

The customer ID who owns the API token.

description

String

The description for the API token.

permissions

Array

The permissions for the API token.

HTTP Response

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

{
  "access_token" : "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInNjb3BlcyI6WyJyZWFkOmFjY291bnQiXSwidXNlcklkIjoxLCJyb2xlIjoiQWRtaW5pc3RyYXRvciIsIm93bmVySWQiOjEwMiwiZGF0YUNlbnRlciI6IlVTX1dlc3QiLCJpc3MiOiJleHRyZW1lY2xvdWRpcS5jb20iLCJpYXQiOjE1OTgzNTg3NDYsImV4cCI6MTU5ODM2MjM0Nn0.aP5lD3i8TfmGSWeGacXmJfhne9rSI_06iaGOzdzMj4k",
  "create_time" : "2024-04-03T19:56:16.000+0000",
  "expire_time" : "2024-04-03T20:56:16.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 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3NiwiZXhwIjoxNzEyNzc4OTc2fQ.0Kal6qLvyzv9Mh1pjMnZyfvZBetkTFJ7GX7fBgYJ--s' \
    -d '{
  "expire_time" : 1712177776,
  "description" : "API Token for account read.",
  "permissions" : [ "write*:auth" ]
}'

Get API token details

GET /auth/apitoken/info

HTTP Request

GET /auth/apitoken/info HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3NiwiZXhwIjoxNzEyNzc4OTc2fQ.0Kal6qLvyzv9Mh1pjMnZyfvZBetkTFJ7GX7fBgYJ--s

Response Fields

Path Type Description

Path	Type	Description
`user_id`	`Number`	Account ID.
`user_name`	`String`	Account login name.
`role`	`String`	User role.
`owner_id`	`Number`	User’s home ownerId.
`data_center`	`String`	User’s data center.
`scopes`	`Array`	Login user’s permissions.
`issued_at`	`String`	The time at which the JWT was issued.
`expiration_time`	`String`	The expiration time on or after which the JWT MUST NOT be accepted for processing.
`expires_in`	`Number`	How many seconds when this token will expires.

user_id

Number

Account ID.

user_name

String

Account login name.

role

String

User role.

owner_id

Number

User’s home ownerId.

data_center

String

User’s data center.

scopes

Array

issued_at

String

The time at which the JWT was issued.

expiration_time

String

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

expires_in

Number

How many seconds when this token will expires.

HTTP Response

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

{
  "user_name" : "admin@cust001.com",
  "user_id" : 1,
  "role" : "Administrator",
  "owner_id" : 102,
  "data_center" : "US_WEST",
  "scopes" : [ "logout", "auth", "auth:r", "token:new", "perm:check", "lro", "lro:r", "account", "account:switch", "account:r", "viq:backup", "user", "user-me:r", "user:r", "hiq", "hiq:r", "org", "org:new", "org:del", "org:rename", "hiq.ctx", "hiq.ctx:r", "hiq.ctx:w", "device", "device:r", "device:list", "device:view", "device:new", "device:del", "device:cli", "device:deploy", "device:manage", "device:unmanage", "device:reboot", "device:reset", "device:thread-commissioner", "client", "client:r", "locations", "locations:r", "network-policy", "policy:ssid", "network-policy:r", "network-scorecard", "network-scorecard:r", "ssid", "ssid:r", "pcg:key", "pcg:key:r", "subscriptions-webhook", "subscriptions-webhook:r", "ccg", "ccg:r", "log", "log:r", "cwp", "cwp:r", "sms-tmpl", "sms-tmpl:r", "class-rule", "class-rule:r", "user-profile", "user-profile:r", "radius-proxy", "radius-proxy:r", "radius-server", "radius-server:r", "usergroup", "usergroup:r", "deployment", "deployment:r", "ad-server", "ad-server:r", "alert", "alert:r", "alert-policies", "alert-policies:r", "alert-subscriptions", "alert-subscriptions:r", "app", "application:r", "l3-address-profile", "l3-address-profile:r", "vlan-profile", "vlan-profile:r", "enduser", "enduser:r", "radius-client-object", "radius-client-object:r", "ldap-server", "ldap-server:r", "email-template", "email-template:r", "certificate", "certificate:r", "radio-profile", "radio-profile:r", "iot-profile", "iot-profile:r", "client-monitor-profile", "client-monitor-profile:r", "copilot-connectivity-wired:r", "copilot-connectivity-wireless:r", "copilot-anomalies:r", "licenses", "licenses:r", "copilot-assurance-scans:r", "packet-capture", "packet-capture:r", "country", "country:r", "cas", "cas:r", "cas-policies", "cas-policies:r", "cas-metadata:r", "cns-subscriptions", "cns-subscriptions:r" ],
  "issued_at" : "2024-04-03T19:56:16.000+0000",
  "expiration_time" : "2024-04-10T19:56:16.000+0000",
  "expires_in" : 604799
}

cURL Request

$ curl 'https://api.extremecloudiq.com/auth/apitoken/info' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3NiwiZXhwIjoxNzEyNzc4OTc2fQ.0Kal6qLvyzv9Mh1pjMnZyfvZBetkTFJ7GX7fBgYJ--s'

Validate API token

POST /auth/apitoken/:validate

Request Body

eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3NiwiZXhwIjoxNzEyNzc4OTc2fQ.0Kal6qLvyzv9Mh1pjMnZyfvZBetkTFJ7GX7fBgYJ--s

HTTP Request

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

eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3NiwiZXhwIjoxNzEyNzc4OTc2fQ.0Kal6qLvyzv9Mh1pjMnZyfvZBetkTFJ7GX7fBgYJ--s

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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3NiwiZXhwIjoxNzEyNzc4OTc2fQ.0Kal6qLvyzv9Mh1pjMnZyfvZBetkTFJ7GX7fBgYJ--s'

Get user permissions

GET /auth/permissions

HTTP Request

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

Response Fields

Path Type Description

Path	Type	Description
`[].name`	`String`	The permission name
`[].description`	`String`	The description for the permission
`[].category`	`String`	The category for the permission

[].name

String

The permission name

[].description

String

The description for the permission

[].category

String

The category for the permission

HTTP Response

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

[ {
  "name" : "logout",
  "description" : "Logout",
  "category" : "Authentication"
}, {
  "name" : "auth",
  "description" : "Full control of authorization",
  "category" : "Authorization"
}, {
  "name" : "auth:r",
  "description" : "Read access to authorization",
  "category" : "Authorization"
}, {
  "name" : "token:new",
  "description" : "Generate API token",
  "category" : "Authorization"
}, {
  "name" : "perm:check",
  "description" : "Check permissions",
  "category" : "Authorization"
}, {
  "name" : "lro",
  "description" : "Full control of long-running operations",
  "category" : "Operation"
}, {
  "name" : "lro:r",
  "description" : "Read access of long-running operations",
  "category" : "Operation"
}, {
  "name" : "account",
  "description" : "Full control of account settings",
  "category" : "Account"
}, {
  "name" : "account:switch",
  "description" : "Switch to another ExtremeCloud IQ account",
  "category" : "Account"
}, {
  "name" : "account:r",
  "description" : "Read access to account settings",
  "category" : "Account"
}, {
  "name" : "viq:backup",
  "description" : "Backup VIQ",
  "category" : "Account"
}, {
  "name" : "user",
  "description" : "Full control of users",
  "category" : "User"
}, {
  "name" : "user-me:r",
  "description" : "Read access to user self",
  "category" : "User"
}, {
  "name" : "user:r",
  "description" : "Read access to users",
  "category" : "User"
}, {
  "name" : "hiq",
  "description" : "Full control of HIQ",
  "category" : "HIQ"
}, {
  "name" : "hiq:r",
  "description" : "Read access to HIQ",
  "category" : "HIQ"
}, {
  "name" : "org",
  "description" : "Full control of HIQ organizations (HIQ account only)",
  "category" : "HIQ"
}, {
  "name" : "org:new",
  "description" : "Create HIQ organization (HIQ account only)",
  "category" : "HIQ"
}, {
  "name" : "org:del",
  "description" : "Delete HIQ organization (HIQ account only)",
  "category" : "HIQ"
}, {
  "name" : "org:rename",
  "description" : "Rename HIQ organization (HIQ account only)",
  "category" : "HIQ"
}, {
  "name" : "hiq.ctx",
  "description" : "Full control of HIQ Context (HIQ account only)",
  "category" : "HIQ"
}, {
  "name" : "hiq.ctx:r",
  "description" : "Read access to HIQ Context (HIQ account only)",
  "category" : "HIQ"
}, {
  "name" : "hiq.ctx:w",
  "description" : "Switching HIQ Context (HIQ account only)",
  "category" : "HIQ"
}, {
  "name" : "device",
  "description" : "Full control of devices",
  "category" : "Device"
}, {
  "name" : "device:r",
  "description" : "Read access to devices",
  "category" : "Device"
}, {
  "name" : "device:list",
  "description" : "Get device list",
  "category" : "Device"
}, {
  "name" : "device:view",
  "description" : "View device details",
  "category" : "Device"
}, {
  "name" : "device:new",
  "description" : "Device onboarding",
  "category" : "Device"
}, {
  "name" : "device:del",
  "description" : "Delete devices",
  "category" : "Device"
}, {
  "name" : "device:cli",
  "description" : "Send CLI to device",
  "category" : "Device"
}, {
  "name" : "device:deploy",
  "description" : "Device push config",
  "category" : "Device"
}, {
  "name" : "device:manage",
  "description" : "Change management status to MANAGED",
  "category" : "Device"
}, {
  "name" : "device:unmanage",
  "description" : "Change management status to UNMANAGED",
  "category" : "Device"
}, {
  "name" : "device:reboot",
  "description" : "Reboot device",
  "category" : "Device"
}, {
  "name" : "device:reset",
  "description" : "Reset the device to factory default",
  "category" : "Device"
}, {
  "name" : "device:thread-commissioner",
  "description" : "Start or Stop Thread Commissioner",
  "category" : "Device"
}, {
  "name" : "client",
  "description" : "Full control of clients",
  "category" : "Client"
}, {
  "name" : "client:r",
  "description" : "Read access to clients",
  "category" : "Client"
}, {
  "name" : "locations",
  "description" : "Full control of locations",
  "category" : "Locations"
}, {
  "name" : "locations:r",
  "description" : "Read access to locations",
  "category" : "Locations"
}, {
  "name" : "network-policy",
  "description" : "Full control of network-policy",
  "category" : "Network Policy"
}, {
  "name" : "policy:ssid",
  "description" : "SSID management on network-policy",
  "category" : "Network Policy"
}, {
  "name" : "network-policy:r",
  "description" : "Read access to network-policy",
  "category" : "Network Policy"
}, {
  "name" : "network-scorecard",
  "description" : "Full control of network-scorecard",
  "category" : "Network Scorecard"
}, {
  "name" : "network-scorecard:r",
  "description" : "Read access to network-scorecard",
  "category" : "Network Scorecard"
}, {
  "name" : "ssid",
  "description" : "Full control of SSID",
  "category" : "SSID"
}, {
  "name" : "ssid:r",
  "description" : "Read access to SSID",
  "category" : "SSID"
}, {
  "name" : "pcg:key",
  "description" : "Full control of PCG key based",
  "category" : "Configuration - User Management"
}, {
  "name" : "pcg:key:r",
  "description" : "Read access to PCG key based",
  "category" : "Configuration - User Management"
}, {
  "name" : "subscriptions-webhook",
  "description" : "Full control of webhook subscription",
  "category" : "WEBHOOK"
}, {
  "name" : "subscriptions-webhook:r",
  "description" : "Read access to webhook subscription",
  "category" : "WEBHOOK"
}, {
  "name" : "ccg",
  "description" : "Full control of CCG",
  "category" : "CCG"
}, {
  "name" : "ccg:r",
  "description" : "Read access to CCG",
  "category" : "CCG"
}, {
  "name" : "log",
  "description" : "Full control of logs",
  "category" : "LOGS"
}, {
  "name" : "log:r",
  "description" : "Read access to logs",
  "category" : "LOGS"
}, {
  "name" : "cwp",
  "description" : "Full control of captive web portals",
  "category" : "Configuration - Authentication"
}, {
  "name" : "cwp:r",
  "description" : "Read access to captive web portals",
  "category" : "Configuration - Authentication"
}, {
  "name" : "sms-tmpl",
  "description" : "Full control of SMS template",
  "category" : "Configuration - User Management"
}, {
  "name" : "sms-tmpl:r",
  "description" : "Read access to SMS template",
  "category" : "Configuration - User Management"
}, {
  "name" : "class-rule",
  "description" : "Full control of classification rule",
  "category" : "Configuration - Policy"
}, {
  "name" : "class-rule:r",
  "description" : "Read access to classification rule",
  "category" : "Configuration - Policy"
}, {
  "name" : "user-profile",
  "description" : "Full control of user profile",
  "category" : "Configuration - Policy"
}, {
  "name" : "user-profile:r",
  "description" : "Read access to user profile",
  "category" : "Configuration - Policy"
}, {
  "name" : "radius-proxy",
  "description" : "Full control of radius proxy",
  "category" : "Configuration - Authentication"
}, {
  "name" : "radius-proxy:r",
  "description" : "Read access to radius proxy",
  "category" : "Configuration - Authentication"
}, {
  "name" : "radius-server",
  "description" : "Full control of RADIUS server",
  "category" : "Configuration - Authentication"
}, {
  "name" : "radius-server:r",
  "description" : "Read access to RADIUS server",
  "category" : "Configuration - Authentication"
}, {
  "name" : "usergroup",
  "description" : "Full control of user group",
  "category" : "Configuration - User Management"
}, {
  "name" : "usergroup:r",
  "description" : "Read access to usergroup",
  "category" : "Configuration - User Management"
}, {
  "name" : "deployment",
  "description" : "Full control of deployment",
  "category" : "Configuration - Deployment"
}, {
  "name" : "deployment:r",
  "description" : "Read access to deployment",
  "category" : "Configuration - Deployment"
}, {
  "name" : "ad-server",
  "description" : "Full control of AD server",
  "category" : "Configuration - Authentication"
}, {
  "name" : "ad-server:r",
  "description" : "Read access to AD server",
  "category" : "Configuration - Authentication"
}, {
  "name" : "alert",
  "description" : "Full control of alert",
  "category" : "Alert"
}, {
  "name" : "alert:r",
  "description" : "Read access to alert",
  "category" : "Alert"
}, {
  "name" : "alert-policies",
  "description" : "Full control of alert policy",
  "category" : "alert-policies"
}, {
  "name" : "alert-policies:r",
  "description" : "Read access to alert policy",
  "category" : "alert-policies"
}, {
  "name" : "alert-subscriptions",
  "description" : "Full control of alert subscription",
  "category" : "alert-subscriptions"
}, {
  "name" : "alert-subscriptions:r",
  "description" : "Read access to alert subscription",
  "category" : "alert-subscriptions"
}, {
  "name" : "app",
  "description" : "Full control of application",
  "category" : "Application"
}, {
  "name" : "application:r",
  "description" : "Read access to application",
  "category" : "Application"
}, {
  "name" : "l3-address-profile",
  "description" : "Full control of L3 address profile",
  "category" : "Configuration - Policy"
}, {
  "name" : "l3-address-profile:r",
  "description" : "Read access to L3 address profile",
  "category" : "Configuration - Policy"
}, {
  "name" : "vlan-profile",
  "description" : "Full control of VLAN profile",
  "category" : "Configuration - Basic"
}, {
  "name" : "vlan-profile:r",
  "description" : "Read access to VLAN profile",
  "category" : "Configuration - Basic"
}, {
  "name" : "enduser",
  "description" : "Full control of end users",
  "category" : "Configuration - User Management"
}, {
  "name" : "enduser:r",
  "description" : "Read access to end users",
  "category" : "Configuration - User Management"
}, {
  "name" : "radius-client-object",
  "description" : "Full control of RADIUS client object",
  "category" : "Configuration - Authentication"
}, {
  "name" : "radius-client-object:r",
  "description" : "Read access to RADIUS client object",
  "category" : "Configuration - Authentication"
}, {
  "name" : "ldap-server",
  "description" : "Full control of LDAP server",
  "category" : "Configuration - Authentication"
}, {
  "name" : "ldap-server:r",
  "description" : "Read access to LDAP server",
  "category" : "Configuration - Authentication"
}, {
  "name" : "email-template",
  "description" : "Full control of email template",
  "category" : "Configuration - User Management"
}, {
  "name" : "email-template:r",
  "description" : "Read access to email template",
  "category" : "Configuration - User Management"
}, {
  "name" : "certificate",
  "description" : "Full control of certificate",
  "category" : "Configuration - Certificate"
}, {
  "name" : "certificate:r",
  "description" : "Read access to certificate",
  "category" : "Configuration - Certificate"
}, {
  "name" : "radio-profile",
  "description" : "Full control of Radio Profile",
  "category" : "Configuration - Policy"
}, {
  "name" : "radio-profile:r",
  "description" : "Read access to Radio Profile",
  "category" : "Configuration - Policy"
}, {
  "name" : "iot-profile",
  "description" : "Full control of IoT Profile",
  "category" : "Configuration - Policy"
}, {
  "name" : "iot-profile:r",
  "description" : "Read access to IoT Profile",
  "category" : "Configuration - Policy"
}, {
  "name" : "client-monitor-profile",
  "description" : "Full control of Client Monitor Profile",
  "category" : "Configuration - Policy"
}, {
  "name" : "client-monitor-profile:r",
  "description" : "Read access to Client Monitor Profile",
  "category" : "Configuration - Policy"
}, {
  "name" : "copilot-connectivity-wired:r",
  "description" : "Read access to Copilot Connectivity wired",
  "category" : "Copilot - Connectivity Experience"
}, {
  "name" : "copilot-connectivity-wireless:r",
  "description" : "Read access to Copilot Connectivity wireless",
  "category" : "Copilot - Connectivity Experience"
}, {
  "name" : "copilot-anomalies:r",
  "description" : "Read access to Copilot Anomalies",
  "category" : "Copilot - Anomalies"
}, {
  "name" : "licenses",
  "description" : "Full control of licenses",
  "category" : "License"
}, {
  "name" : "licenses:r",
  "description" : "Read access to licenses",
  "category" : "Licence"
}, {
  "name" : "copilot-assurance-scans:r",
  "description" : "Read access to Copilot Assurance scan",
  "category" : "Copilot - Anomalies"
}, {
  "name" : "packet-capture",
  "description" : "Full control of packet captures",
  "category" : "Client"
}, {
  "name" : "packet-capture:r",
  "description" : "Read access to packet captures",
  "category" : "Client"
}, {
  "name" : "country",
  "description" : "Full control of country list and country codes",
  "category" : "Misc - Metadata Country"
}, {
  "name" : "country:r",
  "description" : "Read access to country list and country codes",
  "category" : "Misc - Metadata Country"
}, {
  "name" : "cas",
  "description" : "Full control of alert",
  "category" : "cas"
}, {
  "name" : "cas:r",
  "description" : "Read access to alert",
  "category" : "cas"
}, {
  "name" : "cas-policies",
  "description" : "Full control of alert policy",
  "category" : "cas-policies"
}, {
  "name" : "cas-policies:r",
  "description" : "Read access to alert policy",
  "category" : "cas-policies"
}, {
  "name" : "cas-metadata:r",
  "description" : "Read access to alert metadata",
  "category" : "cas-metadata"
}, {
  "name" : "cns-subscriptions",
  "description" : "Full control of alert subscription",
  "category" : "cns-subscriptions"
}, {
  "name" : "cns-subscriptions:r",
  "description" : "Read access to alert subscription",
  "category" : "cns-subscriptions"
} ]

cURL Request

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

Check permissions

POST /auth/permissions/:check

Request Fields

Path Type Description

Path	Type	Description
`uri`	`String`	The request URI.
`method`	`String`	The HTTP request method.

uri

String

The request URI.

method

String

The HTTP request method.

HTTP Request

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

{
  "uri" : "http://localhost:8081/account/info",
  "method" : "get"
}

Response Fields

Path Type Description

Path	Type	Description
`roles[]`	`Array`	The valid roles for request URI and request method
`permissions[].name`	`String`	The permission name.
`permissions[].description`	`String`	The permission description.
`permissions[].category`	`String`	The category for the permission.

roles[]

Array

The valid roles for request URI and request method

permissions[].name

String

The permission name.

permissions[].description

String

The permission description.

permissions[].category

String

The category for the permission.

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
RateLimit-Remaining: 7249
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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MywiZXhwIjoxNzEyNzc4OTczfQ.IXGeKZ28z_wjrXjU2p72LiSqeXevHxn43z6N21oW370' \
    -H 'Content-Type: application/json' \
    -d '{
  "uri" : "http://localhost:8081/account/info",
  "method" : "get"
}'

Account

Switch account

POST /account/:switch

Request Parameters

Parameter	Description
`id`	The ExtremeCloud IQ account ID to switch, 0 means switch back to home XIQ account.

HTTP Request

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

id=1

Response Fields

Path Type Description

Path	Type	Description
`access_token`	`String`	Access token for the new account.
`token_type`	`String`	The type of token, only supports "Bearer" currently
`expires_in`	`Number`	The lifetime in seconds of the access token

access_token

String

Access token for the new account.

token_type

String

The type of token, only supports "Bearer" currently

expires_in

Number

The lifetime in seconds of the access token

HTTP Response

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

{
  "access_token" : "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1NCwiZXhwIjoxNzEyNzc4OTU0fQ.7nL9CfjkYz9niOBsAh6ybrHVyIQ6vMbPedpuZEkHyc8",
  "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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1NCwiZXhwIjoxNzEyNzc4OTU0fQ.7nL9CfjkYz9niOBsAh6ybrHVyIQ6vMbPedpuZEkHyc8' \
    -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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1NCwiZXhwIjoxNzEyNzc4OTU0fQ.7nL9CfjkYz9niOBsAh6ybrHVyIQ6vMbPedpuZEkHyc8

Response Fields

Path Type Description

Path	Type	Description
`[].id`	`Number`	The external account ID.
`[].name`	`String`	The external account name.
`[].create_time`	`String`	The create time.
`[].update_time`	`String`	The last update time.
`[].data_center`	`String`	The default Regional Data Center (RDC) to hold data from customer network.
`[].alias`	`String`	The alias of the external account.
`[].active`	`Boolean`	Flag to indicate whether external account is active.

[].id

Number

The external account ID.

[].name

String

The external account name.

[].create_time

String

The create time.

[].update_time

String

The last update time.

[].data_center

String

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

[].alias

String

The alias of the external account.

[].active

Boolean

Flag to indicate whether external account is active.

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
RateLimit-Remaining: 7334
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: 433

[ {
  "id" : 1,
  "create_time" : "2024-04-03T19:55:54.000+0000",
  "update_time" : "2024-04-03T19:55:54.000+0000",
  "name" : "admin1@cust001.com",
  "alias" : "admin1",
  "active" : false,
  "data_center" : "VA2"
}, {
  "id" : 2,
  "create_time" : "2024-04-03T19:55:54.000+0000",
  "update_time" : "2024-04-03T19:55:54.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1NCwiZXhwIjoxNzEyNzc4OTU0fQ.7nL9CfjkYz9niOBsAh6ybrHVyIQ6vMbPedpuZEkHyc8'

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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1NCwiZXhwIjoxNzEyNzc4OTU0fQ.7nL9CfjkYz9niOBsAh6ybrHVyIQ6vMbPedpuZEkHyc8

Response Fields

Path Type Description

Path	Type	Description
`id`	`Number`	Account ID.
`name`	`String`	Account name.
`create_time`	`String`	Account create time.
`update_time`	`String`	The last update time.
`account_type`	`String`	Account type.
`account_mode`	`String`	Account mode.
`quota`	`String`	The max API requests per minute.
`data_center`	`String`	The default Regional Data Center (RDC) to hold data from customer network.
`industry`	`String`	The industry of the account belongs to.
`country`	`String`	The country for the account.
`state`	`String`	The state for the account, if any.
`city`	`String`	The city for the account.
`address`	`String`	The address for the account.
`zipcode`	`String`	The zipcode of the address.

id

Number

Account ID.

name

String

Account name.

create_time

String

Account create time.

update_time

String

The last update time.

account_type

String

Account type.

account_mode

String

Account mode.

quota

String

The max API requests per minute.

data_center

String

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

industry

String

The industry of the account belongs to.

country

String

The country for the account.

state

String

The state for the account, if any.

city

String

The city for the account.

address

String

The address for the account.

zipcode

String

The zipcode of the address.

HTTP Response

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

{
  "id" : 1,
  "create_time" : "2024-04-03T19:55:54.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1NCwiZXhwIjoxNzEyNzc4OTU0fQ.7nL9CfjkYz9niOBsAh6ybrHVyIQ6vMbPedpuZEkHyc8'

Get VIQ info

GET /account/viq

HTTP Request

GET /account/viq HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1MCwiZXhwIjoxNzEyNzc4OTUwfQ.cVmm_XcuT0PiDrX6qQSQxBx4koy0GyM5oYlQ17mHupg
Content-Type: application/json

Response Fields

Path Type Description

Path	Type	Description
`customer_id`	`String`	Customer ID. a.k.a Salesforce customer ID.
`vhm_id`	`String`	Account name.
`owner_id`	`Number`	Owner Id. a.k.a VHM account ID.
`devices`	`Number`	Total # of licensed devices.
`standalone`	`Boolean`	Whether HHM/HIQ is enabled or if standalone VIQ.
`expired`	`Boolean`	The license subscription expired.
`licenses[]`	`Array`	The license info list.
`licenses[].id`	`Number`	The license id.
`licenses[].status`	`String`	The license status.
`licenses[].mode`	`String`	The license mode.
`licenses[].create_time`	`String`	The license create time.
`licenses[].update_time`	`String`	The license update time.
`licenses[].active_date`	`String`	The license active time.
`licenses[].expire_date`	`String`	The license expire time.
`licenses[].entitlement_key`	`String`	The license entitlement key.
`licenses[].entitlement_type`	`String`	The license entitlement type.
`licenses[].devices`	`Number`	The device number.
`licenses[].activated`	`Number`	The activated device number.
`licenses[].available`	`Number`	The available device number.
`licenses[].license_type`	`String`	The Gemalto license type.

customer_id

String

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

vhm_id

String

Account name.

owner_id

Number

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

devices

Number

Total # of licensed devices.

standalone

Boolean

Whether HHM/HIQ is enabled or if standalone VIQ.

expired

Boolean

The license subscription expired.

licenses[]

Array

The license info list.

licenses[].id

Number

The license id.

licenses[].status

String

The license status.

licenses[].mode

String

The license mode.

licenses[].create_time

String

The license create time.

licenses[].update_time

String

The license update time.

licenses[].active_date

String

The license active time.

licenses[].expire_date

String

The license expire time.

licenses[].entitlement_key

String

The license entitlement key.

licenses[].entitlement_type

String

The license entitlement type.

licenses[].devices

Number

The device number.

licenses[].activated

Number

The activated device number.

licenses[].available

Number

The available device number.

licenses[].license_type

String

The Gemalto license type.

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
RateLimit-Remaining: 7333
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" : "2024-04-03T19:55:50.000+0000",
    "update_time" : "2024-04-03T19:55:50.000+0000",
    "status" : "EVAL",
    "active_date" : "2024-04-03T19:55:50.000+0000",
    "expire_date" : "2025-04-03T19:55:50.000+0000",
    "entitlement_key" : "zzzzz-wwwww-wwwww-wwwww-wwwww-zzzzz",
    "entitlement_type" : "EVALUATION",
    "mode" : "EVAL",
    "devices" : 10,
    "activated" : 10,
    "available" : 100,
    "license_type" : "Legacy"
  }, {
    "id" : 112,
    "create_time" : "2024-02-03T20:55:50.000+0000",
    "update_time" : "2024-02-03T20:55:50.000+0000",
    "status" : "EVAL",
    "active_date" : "2024-03-03T20:55:50.000+0000",
    "expire_date" : "2024-03-27T19:55:50.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 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1MCwiZXhwIjoxNzEyNzc4OTUwfQ.cVmm_XcuT0PiDrX6qQSQxBx4koy0GyM5oYlQ17mHupg' \
    -H 'Content-Type: application/json'

VIQ backup

POST /account/viq/:backup

HTTP Request

POST /account/viq/:backup HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MiwiZXhwIjoxNzEyNzc4OTQyfQ.QRaQvt4YzHvN2Vh819ewHmfcEfF5Bmpb2WZbV8PAdyM
Host: api.extremecloudiq.com
Content-Type: application/json

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
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

cURL Request

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

Get default device password

GET /account/viq/default-device-password

HTTP Request

GET /account/viq/default-device-password HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MiwiZXhwIjoxNzEyNzc4OTQyfQ.QRaQvt4YzHvN2Vh819ewHmfcEfF5Bmpb2WZbV8PAdyM
Host: api.extremecloudiq.com
Content-Type: application/json

Response Fields

Path Type Description

Path	Type	Description
`password`	`String`	The default device password.

password

String

The default device password.

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
Content-Length: 21
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

{
  "password" : ""
}

cURL Request

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

Update Device Default Password

PUT /account/viq/default-device-password

HTTP Request

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

"'0qMFXrPXyD'"

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
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

cURL Request

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

VIQ Export

GET /account/viq/export

Request Parameters

Parameter Description

Parameter	Description
`timeoutInSeconds`	The maximum export duration
`excludeDeviceFirmware`	Whether exclude device firmwares from VIQ export file or not

timeoutInSeconds

The maximum export duration

excludeDeviceFirmware

Whether exclude device firmwares from VIQ export file or not

HTTP Request

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

timeoutInSeconds=1800

Response Fields

Path Type Description

Path	Type	Description
`export_status`	`String`	The viq export status
`export_file_name`	`String`	The viq export report file name
`log_file_name`	`String`	The viq export log file name

export_status

String

The viq export status

export_file_name

String

The viq export report file name

log_file_name

String

The viq export log file name

HTTP Response

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

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

cURL Request

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

VIQ Import

GET /account/viq/import

Request Parameters

Parameter Description

Parameter	Description
`timeoutInSeconds`	The maximum import duration
`resendUserNotifications`	Resend Cloud PPSK/RADIUS password through email/SMS

timeoutInSeconds

The maximum import duration

resendUserNotifications

Resend Cloud PPSK/RADIUS password through email/SMS

HTTP Request

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

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

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


--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--

Response Fields

Path Type Description

Path	Type	Description
`import_status`	`String`	The viq import status
`log_file_name`	`String`	The viq import log file name

import_status

String

The viq import status

log_file_name

String

The viq import log file name

HTTP Response

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

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

cURL Request

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

VIQ Download

GET /account/viq/download

Request Parameters

Parameter Description

Parameter	Description
`reportName`	The report full name

reportName

The report full name

HTTP Request

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

HTTP Response

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

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

cURL Request

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

VIQ Export Import Status

GET /account/viq/export-import-status

Request Parameters

Parameter Description

Parameter	Description
`viqOperationType`	The type of operation to get status

viqOperationType

The type of operation to get status

HTTP Request

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

Response Fields

Path Type Description

Path	Type	Description
`user_name`	`String`	User Name
`vhm_id`	`String`	VHM Id of the user
`operation`	`String`	Type of Operation export/import
`status`	`String`	Status of the request
`total_finish_percentage`	`Number`	Total finish percentage of the operation
`viq_task_progresses[].task_name`	`String`	Name of the task
`viq_task_progresses[].finish_percentage`	`Number`	Percentage of the task
`viq_task_progresses[].detail`	`String`	Detailed info of the task
`viq_task_progresses[].status`	`String`	Status of the task

user_name

String

User Name

vhm_id

String

VHM Id of the user

operation

String

Type of Operation export/import

status

String

Status of the request

total_finish_percentage

Number

Total finish percentage of the operation

viq_task_progresses[].task_name

String

Name of the task

viq_task_progresses[].finish_percentage

Number

Percentage of the task

viq_task_progresses[].detail

String

Detailed info of the task

viq_task_progresses[].status

String

Status of the task

HTTP Response

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

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

cURL Request

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

User

List users

GET /users

Request Parameters

Parameter Description

Parameter	Description
`page`	Page number
`limit`	Page size

page

Page number

limit

Page size

HTTP Request

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

Response Fields

Path Type Description

Path	Type	Description
`page`	`Number`	The current page number.
`count`	`Number`	The element count of the current page.
`total_pages`	`Number`	The total page number based on request page size.
`total_count`	`Number`	The total element count.
`data[].id`	`Number`	The user ID.
`data[].create_time`	`String`	The create time.
`data[].update_time`	`String`	The last update time.
`data[].login_name`	`String`	Login name, i.e. username or login Email.
`data[].first_name`	`String`	The first name.
`data[].last_name`	`String`	The last name, i.e. family name.
`data[].display_name`	`String`	The name to display.
`data[].phone`	`String`	The Phone Number.
`data[].job_title`	`String`	The job title.
`data[].locale`	`String`	The locale.
`data[].idle_timeout`	`Number`	The idle timeout in minutes, the minimum value is 5 minutes and the maximum value is 4 hours.
`data[].last_login_time`	`String`	The last login time.
`data[].org_id`	`Number`	The HIQ org_id if it is HIQ user.
`data[].user_role`	`String`	The user role.
`data[].location_ids`	`Array`	The assigned location IDs.

page

Number

The current page number.

count

Number

The element count of the current page.

total_pages

Number

The total page number based on request page size.

total_count

Number

The total element count.

data[].id

Number

The user ID.

data[].create_time

String

The create time.

data[].update_time

String

The last update time.

data[].login_name

String

data[].first_name

String

The first name.

data[].last_name

String

The last name, i.e. family name.

data[].display_name

String

The name to display.

data[].phone

String

The Phone Number.

data[].job_title

String

The job title.

data[].locale

String

The locale.

data[].idle_timeout

Number

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

data[].last_login_time

String

The last login time.

data[].org_id

Number

The HIQ org_id if it is HIQ user.

data[].user_role

String

The user role.

data[].location_ids

Array

The assigned location IDs.

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
RateLimit-Remaining: 7256
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" : "2024-04-03T19:56:20.000+0000",
    "update_time" : "2024-04-03T19:56:20.000+0000",
    "login_name" : "admin@cust001.com",
    "first_name" : "admin1",
    "last_name" : "admin",
    "display_name" : "Administrator",
    "phone" : "0",
    "job_title" : "IT",
    "locale" : "US",
    "user_role" : "ADMINISTRATOR",
    "idle_timeout" : 10,
    "last_login_time" : "2024-04-03T19:56:20.000+0000",
    "org_id" : 0,
    "location_ids" : [ 438086664193 ]
  }, {
    "id" : 2,
    "create_time" : "2024-04-03T19:56:20.000+0000",
    "update_time" : "2024-04-03T19:56:20.000+0000",
    "login_name" : "admin@cust002.com",
    "first_name" : "admin2",
    "last_name" : "admin",
    "display_name" : "Administrator",
    "phone" : "0",
    "job_title" : "IT",
    "locale" : "US",
    "user_role" : "ADMINISTRATOR",
    "idle_timeout" : 10,
    "last_login_time" : "2024-04-03T19:56:20.000+0000",
    "org_id" : 0,
    "location_ids" : [ 438086664193 ]
  } ]
}

cURL Request

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

Create new user

POST /users

Request Fields

Path Type Description

Path	Type	Description
`login_name`	`String`	The login name
`display_name`	`String`	The display name
`idle_timeout`	`Number`	The idle timeout in minutes
`user_role`	`String`	The user administrative role
`location_ids`	`Array`	The location IDs to assign.

login_name

String

The login name

display_name

String

The display name

idle_timeout

Number

The idle timeout in minutes

user_role

String

The user administrative role

location_ids

Array

The location IDs to assign.

HTTP Request

POST /users HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3OSwiZXhwIjoxNzEyNzc4OTc5fQ.91qNiF_CdFzqY640UsluRF69O7HLFlEOiOnt4ccqrVY
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

Path	Type	Description
`id`	`Number`	User ID.
`create_time`	`String`	User create time.
`update_time`	`String`	User update time.
`login_name`	`String`	Login name, i.e. username or login Email.
`first_name`	`String`	The first name.
`last_name`	`String`	The last name, i.e. family name.
`display_name`	`String`	The name to display.
`phone`	`String`	The Phone Number.
`job_title`	`String`	The job title.
`locale`	`String`	The locale.
`idle_timeout`	`Number`	The idle timeout in minutes, the minimum value is 5 minutes and the maximum value is 4 hours.
`last_login_time`	`String`	The last login time.
`org_id`	`Number`	The HIQ org_id if it is HIQ user.
`user_role`	`String`	The user role.
`location_ids`	`Array`	The assigned location IDs.

id

Number

User ID.

create_time

String

User create time.

update_time

String

User update time.

login_name

String

first_name

String

The first name.

last_name

String

The last name, i.e. family name.

display_name

String

The name to display.

phone

String

The Phone Number.

job_title

String

The job title.

locale

String

The locale.

idle_timeout

Number

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

last_login_time

String

The last login time.

org_id

Number

The HIQ org_id if it is HIQ user.

user_role

String

The user role.

location_ids

Array

The assigned location IDs.

HTTP Response

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

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

cURL Request

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

Get user

GET /users/{id}

Path parameters

Table 1. /users/{id}
Parameter	Description
`id`	User ID

HTTP Request

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

Response Fields

Path Type Description

Path	Type	Description
`id`	`Number`	User ID.
`create_time`	`String`	User create time.
`update_time`	`String`	User update time.
`login_name`	`String`	Login name, i.e. username or login Email.
`first_name`	`String`	The first name.
`last_name`	`String`	The last name, i.e. family name.
`display_name`	`String`	The name to display.
`phone`	`String`	The Phone Number.
`job_title`	`String`	The job title.
`locale`	`String`	The locale.
`idle_timeout`	`Number`	The idle timeout in minutes, the minimum value is 5 minutes and the maximum value is 4 hours.
`last_login_time`	`String`	The last login time.
`org_id`	`Number`	The HIQ org_id if it is HIQ user.
`user_role`	`String`	The user role.
`location_ids`	`Array`	The assigned location IDs.

id

Number

User ID.

create_time

String

User create time.

update_time

String

User update time.

login_name

String

first_name

String

The first name.

last_name

String

The last name, i.e. family name.

display_name

String

The name to display.

phone

String

The Phone Number.

job_title

String

The job title.

locale

String

The locale.

idle_timeout

Number

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

last_login_time

String

The last login time.

org_id

Number

The HIQ org_id if it is HIQ user.

user_role

String

The user role.

location_ids

Array

The assigned location IDs.

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
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
RateLimit-Remaining: 7252

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

cURL Request

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

Delete user

DELETE /users/{id}

Path Parameters

Table 2. /users/{id}
Parameter	Description
`id`	The location ID

HTTP Request

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

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: 7258
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 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3OSwiZXhwIjoxNzEyNzc4OTc5fQ.91qNiF_CdFzqY640UsluRF69O7HLFlEOiOnt4ccqrVY'

Update user

PATCH /users/{id}

Path Parameters

Table 3. /users/{id}
Parameter	Description
`id`	The location ID

Request Fields

Path Type Description

Path	Type	Description
`login_name`	`String`	The login name
`display_name`	`String`	The display name
`idle_timeout`	`Number`	The idle timeout in minutes
`user_role`	`String`	The user administrative role
`location_ids`	`Array`	The location IDs to assign.

login_name

String

The login name

display_name

String

The display name

idle_timeout

Number

The idle timeout in minutes

user_role

String

The user administrative role

location_ids

Array

The location IDs to assign.

HTTP Request

PATCH /users/1 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE4MCwiZXhwIjoxNzEyNzc4OTgwfQ.K3QgskRaKiBprF2Y2O9Kt48f6vub-aIU_svd_1rTevg
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

Path	Type	Description
`id`	`Number`	User ID.
`create_time`	`String`	User create time.
`update_time`	`String`	User update time.
`login_name`	`String`	Login name, i.e. username or login Email.
`first_name`	`String`	The first name.
`last_name`	`String`	The last name, i.e. family name.
`display_name`	`String`	The name to display.
`phone`	`String`	The Phone Number.
`job_title`	`String`	The job title.
`locale`	`String`	The locale.
`idle_timeout`	`Number`	The idle timeout in minutes, the minimum value is 5 minutes and the maximum value is 4 hours.
`last_login_time`	`String`	The last login time.
`org_id`	`Number`	The HIQ org_id if it is HIQ user.
`user_role`	`String`	The user role.
`location_ids`	`Array`	The assigned location IDs.

id

Number

User ID.

create_time

String

User create time.

update_time

String

User update time.

login_name

String

first_name

String

The first name.

last_name

String

The last name, i.e. family name.

display_name

String

The name to display.

phone

String

The Phone Number.

job_title

String

The job title.

locale

String

The locale.

idle_timeout

Number

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

last_login_time

String

The last login time.

org_id

Number

The HIQ org_id if it is HIQ user.

user_role

String

The user role.

location_ids

Array

The assigned location IDs.

HTTP Response

HTTP/1.1 200 OK
RateLimit-Remaining: 7254
Pragma: no-cache
Content-Length: 461
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" : 1,
  "create_time" : "2024-04-03T19:56:20.000+0000",
  "update_time" : "2024-04-03T19:56:20.000+0000",
  "login_name" : "admin@cust001.com",
  "first_name" : "admin1",
  "last_name" : "admin",
  "display_name" : "Administrator",
  "phone" : "0",
  "job_title" : "IT",
  "locale" : "US",
  "user_role" : "ADMINISTRATOR",
  "idle_timeout" : 10,
  "last_login_time" : "2024-04-03T19:56:20.000+0000",
  "org_id" : 0,
  "location_ids" : [ 438086664193 ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/users/1' -i -X PATCH \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE4MCwiZXhwIjoxNzEyNzc4OTgwfQ.K3QgskRaKiBprF2Y2O9Kt48f6vub-aIU_svd_1rTevg' \
    -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

Parameter	Description
`page`	Page number
`limit`	Page size

page

Page number

limit

Page size

HTTP Request

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

Response Fields

Path Type Description

Path	Type	Description
`page`	`Number`	The current page number.
`count`	`Number`	The element count of the current page.
`total_pages`	`Number`	The total page number based on request page size.
`total_count`	`Number`	The total element count.
`data[].id`	`Number`	The external user ID.
`data[].create_time`	`String`	The create time.
`data[].update_time`	`String`	The last update time.
`data[].login_name`	`String`	Login name, i.e. username or login Email.
`data[].org_id`	`Number`	The HIQ org_id if it is HIQ user.
`data[].user_role`	`String`	The user role.
`data[].location_ids`	`Array`	The assigned location IDs.
`data[].grantee_id`	`Number`	The home VIQ user ID of external user.

page

Number

The current page number.

count

Number

The element count of the current page.

total_pages

Number

The total page number based on request page size.

total_count

Number

The total element count.

data[].id

Number

The external user ID.

data[].create_time

String

The create time.

data[].update_time

String

The last update time.

data[].login_name

String

data[].org_id

Number

The HIQ org_id if it is HIQ user.

data[].user_role

String

The user role.

data[].location_ids

Array

The assigned location IDs.

data[].grantee_id

Number

The home VIQ user ID of external user.

HTTP Response

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

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

cURL Request

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

Grant external user

POST /users/external

Request Fields

Path Type Description

Path	Type	Description
`login_name`	`String`	The login name
`user_role`	`String`	The user administrative role
`org_id`	`Number`	The HIQ organization ID if it is HIQ user
`location_ids`	`Array`	The assigned location IDs.

login_name

String

The login name

user_role

String

The user administrative role

org_id

Number

The HIQ organization ID if it is HIQ user

location_ids

Array

The assigned location IDs.

HTTP Request

POST /users/external HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE4MCwiZXhwIjoxNzEyNzc4OTgwfQ.K3QgskRaKiBprF2Y2O9Kt48f6vub-aIU_svd_1rTevg
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

Path	Type	Description
`id`	`Number`	External user ID.
`create_time`	`String`	User create time.
`update_time`	`String`	User update time.
`login_name`	`String`	Login name, i.e. username or login Email.
`org_id`	`Number`	The HIQ org_id if it is HIQ user.
`user_role`	`String`	The user role.
`location_ids`	`Array`	The assigned location IDs.
`grantee_id`	`Number`	The home VIQ user ID of external user.

id

Number

External user ID.

create_time

String

User create time.

update_time

String

User update time.

login_name

String

org_id

Number

The HIQ org_id if it is HIQ user.

user_role

String

The user role.

location_ids

Array

The assigned location IDs.

grantee_id

Number

The home VIQ user ID of external user.

HTTP Response

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

{
  "id" : 1,
  "create_time" : "2024-04-03T19:56:20.000+0000",
  "update_time" : "2024-04-03T19:56:20.000+0000",
  "login_name" : "operator1@extermenetworks.com",
  "user_role" : "OPERATOR",
  "org_id" : 0,
  "location_ids" : [ ],
  "grantee_id" : 1
}

cURL Request

$ curl 'https://api.extremecloudiq.com/users/external' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE4MCwiZXhwIjoxNzEyNzc4OTgwfQ.K3QgskRaKiBprF2Y2O9Kt48f6vub-aIU_svd_1rTevg' \
    -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

Table 4. /users/external/{id}
Parameter	Description
`id`	The external user ID

HTTP Request

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

Response Fields

Path Type Description

Path	Type	Description
`id`	`Number`	External user ID.
`create_time`	`String`	User create time.
`update_time`	`String`	User update time.
`login_name`	`String`	Login name, i.e. username or login Email.
`org_id`	`Number`	The HIQ org_id if it is HIQ user.
`user_role`	`String`	The user role.
`location_ids`	`Array`	The assigned location IDs.
`grantee_id`	`Number`	The home VIQ user ID of external user.

id

Number

External user ID.

create_time

String

User create time.

update_time

String

User update time.

login_name

String

org_id

Number

The HIQ org_id if it is HIQ user.

user_role

String

The user role.

location_ids

Array

The assigned location IDs.

grantee_id

Number

The home VIQ user ID of external user.

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
Content-Length: 252
RateLimit-Limit: 7500;w=3600
RateLimit-Remaining: 7256
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" : 1,
  "create_time" : "2024-04-03T19:56:19.000+0000",
  "update_time" : "2024-04-03T19:56:19.000+0000",
  "login_name" : "operator1@extermenetworks.com",
  "user_role" : "OPERATOR",
  "org_id" : 0,
  "location_ids" : [ ],
  "grantee_id" : 1
}

cURL Request

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

Revoke external user

DELETE /users/external/{id}

Path Parameters

Table 5. /users/external/{id}
Parameter	Description
`id`	The external user ID

HTTP Request

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

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Remaining: 7255
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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE4MCwiZXhwIjoxNzEyNzc4OTgwfQ.K3QgskRaKiBprF2Y2O9Kt48f6vub-aIU_svd_1rTevg' \
    -H 'Content-Type: application/json'

Update external user

PATCH /users/external/{id}

Path Parameters

Table 6. /users/external/{id}
Parameter	Description
`id`	The external user ID

Request Fields

Path Type Description

Path	Type	Description
`user_role`	`String`	The user administrative role
`org_id`	`Number`	The HIQ organization ID if it is HIQ user
`location_ids`	`Array`	The location IDs to assign.

user_role

String

The user administrative role

org_id

Number

The HIQ organization ID if it is HIQ user

location_ids

Array

The location IDs to assign.

HTTP Request

PATCH /users/external/1 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE4MCwiZXhwIjoxNzEyNzc4OTgwfQ.K3QgskRaKiBprF2Y2O9Kt48f6vub-aIU_svd_1rTevg
Content-Length: 30
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: 7249
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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE4MCwiZXhwIjoxNzEyNzc4OTgwfQ.K3QgskRaKiBprF2Y2O9Kt48f6vub-aIU_svd_1rTevg' \
    -H 'Content-Type: application/json' \
    -d '{
  "user_role" : "OPERATOR"
}'

Get current user

GET /users/me

HTTP Request

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

Response Fields

Path Type Description

Path	Type	Description
`id`	`Number`	The user profile ID.
`name`	`String`	The user profile name.
`create_time`	`String`	The create time of user profile.
`update_time`	`String`	The update time of user profile.
`vlan_profile.id`	`Number`	The vlan profile ID.
`vlan_profile.org_id`	`Number`	The vlan profile org ID.
`vlan_profile.create_time`	`String`	The create time.
`vlan_profile.update_time`	`String`	The last update time.
`vlan_profile.name`	`String`	The vlan profile name
`vlan_profile.default_vlan_id`	`Number`	The default vlan ID.
`vlan_profile.enable_classification`	`Boolean`	Enable classification.
`vlan_profile.classified_entries[].id`	`Number`	The classification entry id.
`vlan_profile.classified_entries[].org_id`	`Number`	The classification entry org id.
`vlan_profile.classified_entries[].create_time`	`String`	The create time of classified entry.
`vlan_profile.classified_entries[].update_time`	`String`	The update time of classified entry.
`vlan_profile.classified_entries[].vlan_id`	`Number`	The vlan ID.
`vlan_profile.classified_entries[].classification_rule.id`	`Number`	The classification assignment ID.
`vlan_profile.classified_entries[].classification_rule.org_id`	`Number`	The classification assignment org ID.
`vlan_profile.classified_entries[].classification_rule.name`	`String`	The classification assignment name.
`vlan_profile.classified_entries[].classification_rule.description`	`String`	The classification assignment description.
`vlan_profile.classified_entries[].classification_rule.create_time`	`String`	The create time of classification assignment.
`vlan_profile.classified_entries[].classification_rule.update_time`	`String`	The update time of classification assignment.
`vlan_profile.classified_entries[].classification_rule.classifications[].id`	`Number`	The classification ID.
`vlan_profile.classified_entries[].classification_rule.classifications[].match`	`Boolean`	Match or not match with classifications.
`vlan_profile.classified_entries[].classification_rule.classifications[].value`	`String`	The value of classification.
`vlan_profile.classified_entries[].classification_rule.classifications[].create_time`	`String`	The create time of classification.
`vlan_profile.classified_entries[].classification_rule.classifications[].update_time`	`String`	The update time of classification.
`vlan_profile.classified_entries[].classification_rule.classifications[].classification_type`	`String`	The classification type.
`vlan_profile.classified_entries[].classification_rule.classifications[].classification_id`	`Number`	The classification reference ID.

id

Number

The user profile ID.

name

String

The user profile name.

create_time

String

The create time of user profile.

update_time

String

The update time of user profile.

vlan_profile.id

Number

The vlan profile ID.

vlan_profile.org_id

Number

The vlan profile org ID.

vlan_profile.create_time

String

The create time.

vlan_profile.update_time

String

The last update time.

vlan_profile.name

String

The vlan profile name

vlan_profile.default_vlan_id

Number

The default vlan ID.

vlan_profile.enable_classification

Boolean

Enable classification.

vlan_profile.classified_entries[].id

Number

The classification entry id.

vlan_profile.classified_entries[].org_id

Number

The classification entry org id.

vlan_profile.classified_entries[].create_time

String

The create time of classified entry.

vlan_profile.classified_entries[].update_time

String

The update time of classified entry.

vlan_profile.classified_entries[].vlan_id

Number

The vlan ID.

vlan_profile.classified_entries[].classification_rule.id

Number

The classification assignment ID.

vlan_profile.classified_entries[].classification_rule.org_id

Number

The classification assignment org ID.

vlan_profile.classified_entries[].classification_rule.name

String

The classification assignment name.

vlan_profile.classified_entries[].classification_rule.description

String

The classification assignment description.

vlan_profile.classified_entries[].classification_rule.create_time

String

The create time of classification assignment.

vlan_profile.classified_entries[].classification_rule.update_time

String

The update time of classification assignment.

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

Number

The classification ID.

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

Boolean

Match or not match with classifications.

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

String

The value of classification.

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

String

The create time of classification.

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

String

The update time of classification.

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

String

The classification type.

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

Number

The classification reference ID.

HTTP Response

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

{
  "id" : 1,
  "create_time" : "1970-01-01T00:00:00.000+0000",
  "update_time" : "1970-01-01T00:00:00.000+0000",
  "name" : "User_profile_",
  "vlan_profile" : {
    "id" : 1,
    "create_time" : "1970-01-01T00:00:00.000+0000",
    "update_time" : "1970-01-01T00:00:00.000+0000",
    "org_id" : 0,
    "name" : "VLAN_profile_",
    "default_vlan_id" : 0,
    "enable_classification" : false,
    "classified_entries" : [ {
      "id" : 0,
      "create_time" : "1970-01-01T00:00:00.000+0000",
      "update_time" : "1970-01-01T00:00:00.000+0000",
      "org_id" : 0,
      "vlan_id" : 0,
      "classification_rule" : {
        "id" : 1,
        "create_time" : "2024-04-03T19:55:20.000+0000",
        "update_time" : "2024-04-03T19:55:20.000+0000",
        "org_id" : 0,
        "name" : "10.0.0.1",
        "description" : "IP classification assignment",
        "classifications" : [ {
          "id" : 0,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        }, {
          "id" : 1,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        }, {
          "id" : 2,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        } ]
      }
    }, {
      "id" : 1,
      "create_time" : "1970-01-01T00:00:00.000+0000",
      "update_time" : "1970-01-01T00:00:00.000+0000",
      "org_id" : 0,
      "vlan_id" : 1,
      "classification_rule" : {
        "id" : 1,
        "create_time" : "2024-04-03T19:55:20.000+0000",
        "update_time" : "2024-04-03T19:55:20.000+0000",
        "org_id" : 0,
        "name" : "10.0.0.1",
        "description" : "IP classification assignment",
        "classifications" : [ {
          "id" : 0,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        }, {
          "id" : 1,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        }, {
          "id" : 2,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        } ]
      }
    }, {
      "id" : 2,
      "create_time" : "1970-01-01T00:00:00.000+0000",
      "update_time" : "1970-01-01T00:00:00.000+0000",
      "org_id" : 0,
      "vlan_id" : 2,
      "classification_rule" : {
        "id" : 1,
        "create_time" : "2024-04-03T19:55:20.000+0000",
        "update_time" : "2024-04-03T19:55:20.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 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyMCwiZXhwIjoxNzEyNzc4OTIwfQ.fCVc8nbykfMD0tzQNEGaby8Nbap_Rh_GskiJOghuxJ4' \
    -H 'Content-Type: application/json'

HIQ

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

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

Get HIQ 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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2NywiZXhwIjoxNzEyNzc4OTY3fQ.CYtB0r-WGGhf-LzI2wYA5-X5f9uAT42kP8OrVp0t0-c
Content-Type: application/json

Response Fields

Path Type Description

Path	Type	Description
`reading_org_ids.[]`	`Array`	The organization ID list for reading data (Empty means read data from all organizations in the HIQ).
`creating_org_id`	`Number`	The organization ID for creating new data.

reading_org_ids.[]

Array

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

creating_org_id

Number

The organization ID for creating new data.

HTTP Response

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

{
  "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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2NywiZXhwIjoxNzEyNzc4OTY3fQ.CYtB0r-WGGhf-LzI2wYA5-X5f9uAT42kP8OrVp0t0-c' \
    -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

Path	Type	Description
`creating_org_id`	`Number`	The organization ID for creating new data.
`reading_org_ids`	`Array`	The organization ID list for reading data (Empty means read data from all organizations in the HIQ).

creating_org_id

Number

The organization ID for creating new data.

reading_org_ids

Array

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

HTTP Request

PUT /hiq/context HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2NywiZXhwIjoxNzEyNzc4OTY3fQ.CYtB0r-WGGhf-LzI2wYA5-X5f9uAT42kP8OrVp0t0-c
Content-Length: 62
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: 7318
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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2NywiZXhwIjoxNzEyNzc4OTY3fQ.CYtB0r-WGGhf-LzI2wYA5-X5f9uAT42kP8OrVp0t0-c' \
    -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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2NywiZXhwIjoxNzEyNzc4OTY3fQ.CYtB0r-WGGhf-LzI2wYA5-X5f9uAT42kP8OrVp0t0-c
Content-Type: application/json

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: 1

1

cURL Request

$ curl 'https://api.extremecloudiq.com/hiq/context/creating' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2NywiZXhwIjoxNzEyNzc4OTY3fQ.CYtB0r-WGGhf-LzI2wYA5-X5f9uAT42kP8OrVp0t0-c' \
    -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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2NywiZXhwIjoxNzEyNzc4OTY3fQ.CYtB0r-WGGhf-LzI2wYA5-X5f9uAT42kP8OrVp0t0-c
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: 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/hiq/context/creating' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2NywiZXhwIjoxNzEyNzc4OTY3fQ.CYtB0r-WGGhf-LzI2wYA5-X5f9uAT42kP8OrVp0t0-c' \
    -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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2NywiZXhwIjoxNzEyNzc4OTY3fQ.CYtB0r-WGGhf-LzI2wYA5-X5f9uAT42kP8OrVp0t0-c
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
Content-Length: 11
Expires: 0
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

[ 1, 2, 3 ]

cURL Request

$ curl 'https://api.extremecloudiq.com/hiq/context/reading' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2NywiZXhwIjoxNzEyNzc4OTY3fQ.CYtB0r-WGGhf-LzI2wYA5-X5f9uAT42kP8OrVp0t0-c' \
    -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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2NywiZXhwIjoxNzEyNzc4OTY3fQ.CYtB0r-WGGhf-LzI2wYA5-X5f9uAT42kP8OrVp0t0-c
Content-Type: application/json

[ 1, 2, 3 ]

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
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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2NywiZXhwIjoxNzEyNzc4OTY3fQ.CYtB0r-WGGhf-LzI2wYA5-X5f9uAT42kP8OrVp0t0-c' \
    -H 'Content-Type: application/json' \
    -d '[ 1, 2, 3 ]'

Get all organizations

GET /hiq/organizations

HTTP Request

GET /hiq/organizations HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2NywiZXhwIjoxNzEyNzc4OTY3fQ.CYtB0r-WGGhf-LzI2wYA5-X5f9uAT42kP8OrVp0t0-c
Content-Type: application/json

Response Fields

Path Type Description

Path	Type	Description
`[].id`	`Number`	The unique identifier.
`[].create_time`	`String`	The create time.
`[].update_time`	`String`	The last update time.
`[].org_id`	`Number`	The organization identifier, valid when enabling HIQ feature.
`[].name`	`String`	The organization name.
`[].type`	`class com.extremecloudiq.grpc.hiq.v1.OrganizationType`	The organization type.
`[].color`	`String`	tagged color for the organization.

[].id

Number

The unique identifier.

[].create_time

String

The create time.

[].update_time

String

The last update time.

[].org_id

Number

The organization identifier, valid when enabling HIQ feature.

[].name

String

The organization name.

[].type

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

The organization type.

[].color

String

tagged color for the organization.

HTTP Response

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

[ {
  "id" : 1,
  "create_time" : "2024-04-03T19:56:07.000+0000",
  "update_time" : "2024-04-03T19:56:07.000+0000",
  "org_id" : 1,
  "name" : "Example-corp-0",
  "type" : "REGULAR",
  "color" : "red"
}, {
  "id" : 2,
  "create_time" : "2024-04-03T19:56:07.000+0000",
  "update_time" : "2024-04-03T19:56:07.000+0000",
  "org_id" : 2,
  "name" : "Example-corp-1",
  "type" : "REGULAR",
  "color" : "red"
}, {
  "id" : 3,
  "create_time" : "2024-04-03T19:56:07.000+0000",
  "update_time" : "2024-04-03T19:56:07.000+0000",
  "org_id" : 3,
  "name" : "Example-corp-2",
  "type" : "REGULAR",
  "color" : "red"
}, {
  "id" : 4,
  "create_time" : "2024-04-03T19:56:07.000+0000",
  "update_time" : "2024-04-03T19:56:07.000+0000",
  "org_id" : 4,
  "name" : "Example-corp-3",
  "type" : "REGULAR",
  "color" : "red"
}, {
  "id" : 5,
  "create_time" : "2024-04-03T19:56:07.000+0000",
  "update_time" : "2024-04-03T19:56:07.000+0000",
  "org_id" : 5,
  "name" : "Example-corp-4",
  "type" : "REGULAR",
  "color" : "red"
}, {
  "id" : 6,
  "create_time" : "2024-04-03T19:56:07.000+0000",
  "update_time" : "2024-04-03T19:56:07.000+0000",
  "org_id" : 6,
  "name" : "Example-corp-5",
  "type" : "REGULAR",
  "color" : "red"
}, {
  "id" : 7,
  "create_time" : "2024-04-03T19:56:07.000+0000",
  "update_time" : "2024-04-03T19:56:07.000+0000",
  "org_id" : 7,
  "name" : "Example-corp-6",
  "type" : "REGULAR",
  "color" : "red"
}, {
  "id" : 8,
  "create_time" : "2024-04-03T19:56:07.000+0000",
  "update_time" : "2024-04-03T19:56:07.000+0000",
  "org_id" : 8,
  "name" : "Example-corp-7",
  "type" : "REGULAR",
  "color" : "red"
}, {
  "id" : 9,
  "create_time" : "2024-04-03T19:56:07.000+0000",
  "update_time" : "2024-04-03T19:56:07.000+0000",
  "org_id" : 9,
  "name" : "Example-corp-8",
  "type" : "REGULAR",
  "color" : "red"
}, {
  "id" : 10,
  "create_time" : "2024-04-03T19:56:07.000+0000",
  "update_time" : "2024-04-03T19:56:07.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2NywiZXhwIjoxNzEyNzc4OTY3fQ.CYtB0r-WGGhf-LzI2wYA5-X5f9uAT42kP8OrVp0t0-c' \
    -H 'Content-Type: application/json'

Create organization

POST /hiq/organizations

Request Fields

Path Type Description

Path	Type	Description
`name`	`String`	The organization name, must be unique in VIQ.
`color`	`String`	The tagged color for the organization.

name

String

The organization name, must be unique in VIQ.

color

String

The tagged color for the organization.

HTTP Request

POST /hiq/organizations HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2NywiZXhwIjoxNzEyNzc4OTY3fQ.CYtB0r-WGGhf-LzI2wYA5-X5f9uAT42kP8OrVp0t0-c
Content-Type: application/json
Content-Length: 56

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

Response Fields

Path Type Description

Path	Type	Description
`id`	`Number`	The unique identifier.
`create_time`	`String`	The create time.
`update_time`	`String`	The last update time.
`org_id`	`Number`	The organization identifier, valid when enabling HIQ feature.
`name`	`String`	The organization name.
`type`	`class com.extremecloudiq.grpc.hiq.v1.OrganizationType`	The organization type.
`color`	`String`	tagged color for the organization.

id

Number

The unique identifier.

create_time

String

The create time.

update_time

String

The last update time.

org_id

Number

The organization identifier, valid when enabling HIQ feature.

name

String

The organization name.

type

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

The organization type.

color

String

tagged color for the organization.

HTTP Response

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

{
  "id" : 1,
  "create_time" : "2024-04-03T19:56:07.000+0000",
  "update_time" : "2024-04-03T19:56:07.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2NywiZXhwIjoxNzEyNzc4OTY3fQ.CYtB0r-WGGhf-LzI2wYA5-X5f9uAT42kP8OrVp0t0-c' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "example-organization",
  "color" : "red"
}'

Delete organization

DELETE /hiq/organizations/{id}

Path Parameters

Table 7. /hiq/organizations/{id}
Parameter	Description
`id`	Organization ID to delete.

HTTP Request

DELETE /hiq/organizations/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2NywiZXhwIjoxNzEyNzc4OTY3fQ.CYtB0r-WGGhf-LzI2wYA5-X5f9uAT42kP8OrVp0t0-c
Content-Type: application/json

HTTP Response

HTTP/1.1 204 No Content
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
RateLimit-Remaining: 7325
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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2NywiZXhwIjoxNzEyNzc4OTY3fQ.CYtB0r-WGGhf-LzI2wYA5-X5f9uAT42kP8OrVp0t0-c' \
    -H 'Content-Type: application/json'

Rename organization

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

Path Parameters

Table 8. /hiq/organizations/{id}/:rename
Parameter	Description
`id`	Organization ID to delete.

HTTP Request

POST /hiq/organizations/438086664193/:rename HTTP/1.1
Host: api.extremecloudiq.com
Content-Length: 21
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2NywiZXhwIjoxNzEyNzc4OTY3fQ.CYtB0r-WGGhf-LzI2wYA5-X5f9uAT42kP8OrVp0t0-c
Content-Type: application/json

New organization name

HTTP Response

HTTP/1.1 204 No Content
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
RateLimit-Remaining: 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/hiq/organizations/438086664193/:rename' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2NywiZXhwIjoxNzEyNzc4OTY3fQ.CYtB0r-WGGhf-LzI2wYA5-X5f9uAT42kP8OrVp0t0-c' \
    -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
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2NiwiZXhwIjoxNzEyNzc4OTY2fQ.t75TK2o4gjgn50jU6kcDI9MUAjcdE1S1XSmcco2oJwc

Response Fields

Path Type Description

enabled

Boolean

Whether HIQ is enabled or not.

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Content-Length: 22
Expires: 0
X-Content-Type-Options: nosniff
RateLimit-Remaining: 7325
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 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2NiwiZXhwIjoxNzEyNzc4OTY2fQ.t75TK2o4gjgn50jU6kcDI9MUAjcdE1S1XSmcco2oJwc'

Location

Initialize location

POST /locations/:init

Request Fields

Path Type Description

organization

String

The organization name

country

String

The organization country code

HTTP Request

POST /locations/:init HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1OCwiZXhwIjoxNzEyNzc4OTU4fQ.cf3WHDGd6sEOvG5g6Q1meHkvycrNm8mFvwV_ruGdazs
Host: api.extremecloudiq.com
Content-Type: application/json
Content-Length: 67

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

Response Fields

Path Type Description

id

Number

The location ID

create_time

String

The create time

update_time

String

The last update time

org_id

Number

The organization identifier, valid when enabling HIQ feature

name

String

The location name

unique_name

String

The location unique name

parent_id

Number

The parent location ID

type

String

The location type

address

String

The location address

children[].id

Number

The children location ID

children[].create_time

String

The create time of children location

children[].update_time

String

The last update time of children location

children[].org_id

Number

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

children[].name

String

The name of children location

children[].unique_name

String

The unique name of children location

children[].parent_id

Number

The parent location ID of children location

children[].type

String

The type of children location

children[].address

String

The location address of children location

children[].children

Array

The children of children location

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-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: 674

{
  "id" : 438086664193,
  "create_time" : "2024-04-03T19:55:58.000+0000",
  "update_time" : "2024-04-03T19:55:58.000+0000",
  "org_id" : 0,
  "name" : "Extreme Org",
  "unique_name" : "Extreme Org",
  "type" : "Location",
  "address" : "addressLine1, addressLine2, city, state, postalCode",
  "children" : [ {
    "id" : 438086665192,
    "create_time" : "2024-04-03T19:55:58.000+0000",
    "update_time" : "2024-04-03T19:55:58.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1OCwiZXhwIjoxNzEyNzc4OTU4fQ.cf3WHDGd6sEOvG5g6Q1meHkvycrNm8mFvwV_ruGdazs' \
    -H 'Content-Type: application/json' \
    -d '{
  "organization" : "Extreme Org",
  "country" : "AFGHANISTAN_4"
}'

Create location

POST /locations

Request Fields

Path Type Description

name

String

The location name

parent_id

Number

The parent location ID

HTTP Request

POST /locations HTTP/1.1
Host: api.extremecloudiq.com
Content-Length: 44
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1OSwiZXhwIjoxNzEyNzc4OTU5fQ.bU74bVVk4gO9JceWCSzfrFinfTQ9doMRrujVlnQta-Q

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

Response Fields

Path Type Description

id

Number

The location ID

create_time

String

The create time

update_time

String

The last update time

org_id

Number

The organization identifier, valid when enabling HIQ feature

name

String

The location name

unique_name

String

The location unique name

parent_id

Number

The location parent ID

type

String

The location type

address

String

The location address

children[].id

Number

The children location ID

children[].create_time

String

The create time of children location

children[].update_time

String

The last update time of children location

children[].org_id

Number

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

children[].name

String

The name of children location

children[].unique_name

String

The unique name of children location

children[].parent_id

Number

The parent location ID of children location

children[].type

String

The type of children location

children[].address

String

The location address of children

children[].children

Array

The children of children location

HTTP Response

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

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

cURL Request

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

Update location

PUT /locations/{id}

Path Parameters

Table 9. /locations/{id}
Parameter	Description
`id`	The location ID

Request Fields

Path Type Description

name

String

The location name

parent_id

Number

The parent location ID

HTTP Request

PUT /locations/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1NywiZXhwIjoxNzEyNzc4OTU3fQ.W3iVJfD9-qD9cBJduHe9XKo1OifM07NR6bY3PWSMPbg
Content-Length: 57

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

Response Fields

Path Type Description

id

Number

The location ID

create_time

String

The create time

update_time

String

The last update time

org_id

Number

The organization identifier, valid when enabling HIQ feature

name

String

The location name

unique_name

String

The location unique name

parent_id

Number

The parent location ID

type

String

The location type

address

String

The location address

children[].id

Number

The children location ID

children[].create_time

String

The create time of children location

children[].update_time

String

The last update time of children location

children[].org_id

Number

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

children[].name

String

The name of children location

children[].unique_name

String

The unique name of children location

children[].parent_id

Number

The parent location ID of children location

children[].type

String

The type of children location

children[].address

String

The location address of children location

children[].children

Array

The children of children location

HTTP Response

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

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

cURL Request

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

Delete location

DELETE /locations/{id}

Path Parameters

Table 10. /locations/{id}
Parameter	Description
`id`	The location ID

Request parameters

Parameter Description

force_delete

Force deletion of this location and its descendants recursively

HTTP Request

DELETE /locations/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1OSwiZXhwIjoxNzEyNzc4OTU5fQ.bU74bVVk4gO9JceWCSzfrFinfTQ9doMRrujVlnQta-Q

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
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/438086664193' -i -X DELETE \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1OSwiZXhwIjoxNzEyNzc4OTU5fQ.bU74bVVk4gO9JceWCSzfrFinfTQ9doMRrujVlnQta-Q'

Create building

POST /locations/building

Request Fields

Path Type Description

name

String

The building name

parent_id

Number

The parent location ID

address.address

String

The building address line1

address.address2

String

The building address line2

address.city

String

The building address city

address.state

String

The building address state

address.postal_code

String

The building address postal/zip code

latitude

Number

The latitude coordinate for the building

longitude

Number

The longitude coordinate for the building

HTTP Request

POST /locations/building HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Content-Length: 287
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1OSwiZXhwIjoxNzEyNzc4OTU5fQ.bU74bVVk4gO9JceWCSzfrFinfTQ9doMRrujVlnQta-Q

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

Response Fields

Path Type Description

id

Number

The building ID

create_time

String

The create time

update_time

String

The last update time

org_id

Number

The organization identifier, valid when enabling HIQ feature

name

String

The building name

parent_id

Number

The parent location ID

address.address

String

The building address line1

address.address2

String

The building address line2

address.city

String

The building address city

address.state

String

The building address state

address.postal_code

String

The building address postal/zip code

latitude

Number

The latitude coordinate for the building

longitude

Number

The longitude coordinate for the building

HTTP Response

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

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

cURL Request

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

Update building

PUT /locations/building/{id}

Path Parameters

Table 11. /locations/building/{id}
Parameter	Description
`id`	The location ID

Request Fields

Path Type Description

name

String

The building name

parent_id

Number

The parent location ID

address.address

String

The building address line1

address.address2

String

The building address line2

address.city

String

The building address city

address.state

String

The building address state

address.postal_code

String

The building address postal/zip code

latitude

Number

The latitude coordinate for the building

longitude

Number

The longitude coordinate for the building

HTTP Request

PUT /locations/building/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1NywiZXhwIjoxNzEyNzc4OTU3fQ.W3iVJfD9-qD9cBJduHe9XKo1OifM07NR6bY3PWSMPbg
Content-Length: 287

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

Response Fields

Path Type Description

id

Number

The building ID

create_time

String

The create time

update_time

String

The last update time

org_id

Number

The organization identifier, valid when enabling HIQ feature

name

String

The building name

parent_id

Number

The parent location ID

address.address

String

The building address line1

address.address2

String

The building address line2

address.city

String

The building address city

address.state

String

The building address state

address.postal_code

String

The building address postal/zip code

latitude

Number

The latitude coordinate for the building

longitude

Number

The longitude coordinate for the building

HTTP Response

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

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

cURL Request

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

Delete building

DELETE /locations/building/{id}

Path Parameters

Table 12. /locations/building/{id}
Parameter	Description
`id`	The location ID

Request parameters

Parameter Description

force_delete

Force deletion of this building and its descendants recursively

HTTP Request

DELETE /locations/building/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1OSwiZXhwIjoxNzEyNzc4OTU5fQ.bU74bVVk4gO9JceWCSzfrFinfTQ9doMRrujVlnQta-Q

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/locations/building/438086664193' -i -X DELETE \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1OSwiZXhwIjoxNzEyNzc4OTU5fQ.bU74bVVk4gO9JceWCSzfrFinfTQ9doMRrujVlnQta-Q'

List buildings

GET /locations/building

Request parameters

Parameter Description

page

Page number

limit

Page size

name

order

The sort order by name (ascending by default)

HTTP Request

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

Response Fields

Path Type Description

page

Number

The current page number

count

Number

The element count of the current page

total_pages

Number

The total page number based on request page size

total_count

Number

The total element count

data[].id

Number

The building ID

data[].create_time

String

The create time

data[].update_time

String

The last update time

data[].org_id

Number

The organization identifier, valid when enabling HIQ feature

data[].name

String

The building name

data[].parent_id

Number

The parent location ID

data[].address.address

String

The building address line1

data[].address.address2

String

The building address line2

data[].address.city

String

The building address city

data[].address.state

String

The building address state

data[].address.postal_code

String

The building address postal/zip code

data[].latitude

Number

The latitude coordinate for the building

data[].longitude

Number

The longitude coordinate for the building

HTTP Response

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

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

cURL Request

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

Create site

POST /locations/site

Request Fields

Path Type Description

name

String

The site name

parent_id

Number

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

address.address

String

The site address line1

address.address2

String

The site address line2

address.city

String

The site address city

address.state

String

The site address state

address.postal_code

String

The site address postal/zip code

country_code

Number

The country code for the site

latitude

Number

The latitude coordinate for the site

longitude

Number

The longitude coordinate for the site

HTTP Request

POST /locations/site HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Content-Length: 310
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1OSwiZXhwIjoxNzEyNzc4OTU5fQ.bU74bVVk4gO9JceWCSzfrFinfTQ9doMRrujVlnQta-Q

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

Response Fields

Path Type Description

id

Number

The site ID

create_time

String

The create time

update_time

String

The last update time

org_id

Number

The organization identifier, valid when enabling HIQ feature

name

String

The site name

unique_name

String

The site unique name

parent_id

Number

The site parent ID

type

String

The location type

address.address

String

The site address line1

address.address2

String

The site address line2

address.city

String

The site address city

address.state

String

The site address state

address.postal_code

String

The site address postal/zip code

country_code

Number

The country code for the site

created_by

Number

The user ID used to create the site

latitude

Number

The latitude coordinate for the site

longitude

Number

The longitude coordinate for the site

HTTP Response

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

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

cURL Request

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

Update site

PUT /locations/site/{id}

Path Parameters

Table 13. /locations/site/{id}
Parameter	Description
`id`	The site ID

Request Fields

Path Type Description

name

String

The site name

parent_id

Number

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

address.address

String

The site address line1

address.address2

String

The site address line2

address.city

String

The site address city

address.state

String

The site address state

address.postal_code

String

The site address postal/zip code

country_code

Number

The country code for the site

latitude

Number

The latitude coordinate for the site

longitude

Number

The longitude coordinate for the site

HTTP Request

PUT /locations/site/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1OCwiZXhwIjoxNzEyNzc4OTU4fQ.cf3WHDGd6sEOvG5g6Q1meHkvycrNm8mFvwV_ruGdazs
Host: api.extremecloudiq.com
Content-Type: application/json
Content-Length: 310

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

Response Fields

Path Type Description

id

Number

The site ID

create_time

String

The create time

update_time

String

The last update time

org_id

Number

The organization identifier, valid when enabling HIQ feature

name

String

The site name

unique_name

String

The site unique name

parent_id

Number

The site parent ID

type

String

The location type

address.address

String

The site address line1

address.address2

String

The site address line2

address.city

String

The site address city

address.state

String

The site address state

address.postal_code

String

The site address postal/zip code

country_code

Number

The country code for the site

created_by

Number

The user ID used to create the site

latitude

Number

The latitude coordinate for the site

longitude

Number

The longitude coordinate for the site

HTTP Response

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

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

cURL Request

$ curl 'https://api.extremecloudiq.com/locations/site/438086664193' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1OCwiZXhwIjoxNzEyNzc4OTU4fQ.cf3WHDGd6sEOvG5g6Q1meHkvycrNm8mFvwV_ruGdazs' \
    -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,
  "latitude" : 37.23846552983368,
  "longitude" : -121.7852542
}'

Delete site

DELETE /locations/site/{id}

Path Parameters

Table 14. /locations/site/{id}
Parameter	Description
`id`	The site ID

Request parameters

Parameter Description

force_delete

Force deletion of this location and its descendants recursively

HTTP Request

DELETE /locations/site/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1OSwiZXhwIjoxNzEyNzc4OTU5fQ.bU74bVVk4gO9JceWCSzfrFinfTQ9doMRrujVlnQta-Q

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
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

cURL Request

$ curl 'https://api.extremecloudiq.com/locations/site/438086664193' -i -X DELETE \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1OSwiZXhwIjoxNzEyNzc4OTU5fQ.bU74bVVk4gO9JceWCSzfrFinfTQ9doMRrujVlnQta-Q'

Get site

Get /locations/site/{id}

Path parameters

Table 15. /locations/site/{id}
Parameter	Description
`id`	The site ID

HTTP Request

GET /locations/site/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1OCwiZXhwIjoxNzEyNzc4OTU4fQ.cf3WHDGd6sEOvG5g6Q1meHkvycrNm8mFvwV_ruGdazs
Host: api.extremecloudiq.com
Content-Type: application/json

Response Fields

Path Type Description

id

Number

The site ID

create_time

String

The create time

update_time

String

The last update time

org_id

Number

The organization identifier, valid when enabling HIQ feature

name

String

The site name

unique_name

String

The site unique name

type

String

The location type

created_by

Number

The user ID used to create the site

latitude

Number

The latitude coordinate for the site address

longitude

Number

The longitude coordinate for the site address

parent_id

Number

The site parent ID

address.address

String

The site address line1

address.address2

String

The site address line2

address.city

String

The site address city

address.state

String

The site address state

address.postal_code

String

The site address postal/zip code

country_code

Number

The country code for the site

created_by

Number

The user ID used to create the site

latitude

Number

The latitude coordinate for the site

longitude

Number

The longitude coordinate for the site

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Length: 516
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" : 438086664193,
  "create_time" : "2024-04-03T19:55:58.000+0000",
  "update_time" : "2024-04-03T19:55:58.000+0000",
  "org_id" : 0,
  "parent_id" : 438086664292,
  "name" : "test-loc",
  "unique_name" : "test-loc",
  "type" : "INDOOR",
  "address" : {
    "address" : "addressLine1",
    "address2" : "addressLine2",
    "city" : "city",
    "state" : "state",
    "postal_code" : "postalCode"
  },
  "country_code" : 840,
  "created_by" : 1,
  "latitude" : 37.23846552983368,
  "longitude" : -121.7852542
}

cURL Request

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

List sites

GET /locations/site

Request parameters

Parameter Description

page

Page number

limit

Page size

name

order

The sort order by name (ascending by default)

HTTP Request

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

Response Fields

Path Type Description

page

Number

The current page number

count

Number

The element count of the current page

total_pages

Number

The total page number based on request page size

total_count

Number

The total element count

data[].id

Number

The site ID

data[].create_time

String

The create time

data[].update_time

String

The last update time

data[].org_id

Number

The organization identifier, valid when enabling HIQ feature

data[].name

String

The site name

data[].unique_name

String

The site unique name

data[].parent_id

Number

The site parent ID

data[].type

String

The location type

data[].address.address

String

The site address line1

data[].address.address2

String

The site address line2

data[].address.city

String

The site address city

data[].address.state

String

The site address state

data[].address.postal_code

String

The site address postal/zip code

data[].country_code

Number

The country code for the site

data[].created_by

Number

The user ID used to create the site

data[].latitude

Number

The latitude coordinate for the site

data[].longitude

Number

The longitude coordinate for the site

HTTP Response

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

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

cURL Request

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

Create floor

POST /locations/floor

Request Fields

Path Type Description

name

String

The floor name

parent_id

Number

The parent building ID

environment

String

The RF environment of floor

db_attenuation

Number

The floor attenuation of floor

measurement_unit

String

The measurement unit of floor

installation_height

Number

The installation height of floor

map_size_width

Number

The floor map width

map_size_height

Number

The floor map height

map_name

String

The floor map name

HTTP Request

POST /locations/floor HTTP/1.1
Host: api.extremecloudiq.com
Content-Length: 260
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1NywiZXhwIjoxNzEyNzc4OTU3fQ.W3iVJfD9-qD9cBJduHe9XKo1OifM07NR6bY3PWSMPbg

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

Response Fields

Path Type Description

id

Number

The floor ID

create_time

String

The create time

update_time

String

The last update time

org_id

Number

The organization identifier, valid when enabling HIQ feature

name

String

The floor name

unique_name

String

The unique name of floor

parent_id

Number

The parent building ID

environment

String

The RF environment of floor

db_attenuation

Number

The floor attenuation of floor

measurement_unit

String

The measurement unit of floor

installation_height

Number

The installation height of floor

map_size_width

Number

The floor map width

map_size_height

Number

The floor map height

map_name

String

The floor map name

HTTP Response

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

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

cURL Request

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

Update floor

PUT /locations/floor/{id}

Path Parameters

Table 16. /locations/floor/{id}
Parameter	Description
`id`	The floor ID

Request Fields

Path Type Description

name

String

The floor name

parent_id

Number

The parent building ID

environment

String

The RF environment of floor

db_attenuation

Number

The floor attenuation of floor

measurement_unit

String

The measurement unit of floor

installation_height

Number

The installation height of floor

map_size_width

Number

The floor map width

map_size_height

Number

The floor map height

map_name

String

The floor map name

HTTP Request

PUT /locations/floor/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1OCwiZXhwIjoxNzEyNzc4OTU4fQ.cf3WHDGd6sEOvG5g6Q1meHkvycrNm8mFvwV_ruGdazs
Host: api.extremecloudiq.com
Content-Length: 260
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

id

Number

The floor ID

create_time

String

The create time

update_time

String

The last update time

org_id

Number

The organization identifier, valid when enabling HIQ feature

name

String

The floor name

unique_name

String

The unique name of floor

parent_id

Number

The parent building ID

environment

String

The RF environment of floor

db_attenuation

Number

The floor attenuation of floor

measurement_unit

String

The measurement unit of floor

installation_height

Number

The installation height of floor

map_size_width

Number

The floor map width

map_size_height

Number

The floor map height

map_name

String

The floor map name

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
RateLimit-Remaining: 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
Content-Length: 431

{
  "id" : 438086664193,
  "create_time" : "2024-04-03T19:55:58.000+0000",
  "update_time" : "2024-04-03T19:55:58.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1OCwiZXhwIjoxNzEyNzc4OTU4fQ.cf3WHDGd6sEOvG5g6Q1meHkvycrNm8mFvwV_ruGdazs' \
    -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

Table 17. /locations/floor/{id}
Parameter	Description
`id`	The floor ID

HTTP Request

DELETE /locations/floor/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1OCwiZXhwIjoxNzEyNzc4OTU4fQ.cf3WHDGd6sEOvG5g6Q1meHkvycrNm8mFvwV_ruGdazs
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/locations/floor/438086664193' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1OCwiZXhwIjoxNzEyNzc4OTU4fQ.cf3WHDGd6sEOvG5g6Q1meHkvycrNm8mFvwV_ruGdazs' \
    -H 'Content-Type: application/json'

List floors

GET /locations/floor

Request parameters

Parameter Description

page

Page number

limit

Page size

name

order

The sort order by name (ascending by default)

HTTP Request

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

Response Fields

Path Type Description

page

Number

The current page number

count

Number

The element count of the current page

total_pages

Number

The total page number based on request page size

total_count

Number

The total element count

data[].id

Number

The floor ID

data[].create_time

String

The create time

data[].update_time

String

The last update time

data[].org_id

Number

The organization identifier, valid when enabling HIQ feature

data[].name

String

The floor name

data[].unique_name

String

The unique name of floor

data[].parent_id

Number

The parent building ID

data[].environment

String

The RF environment of floor

data[].db_attenuation

Number

The floor attenuation of floor

data[].measurement_unit

String

The measurement unit of floor

data[].installation_height

Number

The installation height of floor

data[].map_size_width

Number

The floor map width

data[].map_size_height

Number

The floor map height

data[].map_name

String

The floor map name

HTTP Response

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

{
  "page" : 1,
  "count" : 0,
  "total_pages" : 0,
  "total_count" : 0,
  "data" : [ {
    "id" : 438086664193,
    "create_time" : "2024-04-03T19:55:57.000+0000",
    "update_time" : "2024-04-03T19:55:57.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 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1NywiZXhwIjoxNzEyNzc4OTU3fQ.W3iVJfD9-qD9cBJduHe9XKo1OifM07NR6bY3PWSMPbg'

Upload floor plan

POST /locations/floorplan

HTTP Request

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

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

data
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
RateLimit-Remaining: 7328
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 'Content-Type: multipart/form-data' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1NywiZXhwIjoxNzEyNzc4OTU3fQ.W3iVJfD9-qD9cBJduHe9XKo1OifM07NR6bY3PWSMPbg' \
    -F 'file=@image.png;type=images/png'

Get location tree

GET /locations/tree

Request Parameters

Parameter Description

parentId

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

expandChildren

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

HTTP Request

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

Response Fields

Path Type Description

[].id

Number

The location ID.

[].create_time

String

The timestamp when the location was created.

[].update_time

String

The timestamp when the location was last updated.

[].org_id

Number

The organization ID.

[].parent_id

Number

The parent location ID.

[].name

String

The location name.

[].unique_name

String

The unique location name.

[].type

String

The location type.

[].address

String

The address for the location.

[].children

Array

The child locations.

HTTP Response

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

[ {
  "id" : 438086664193,
  "create_time" : "2024-04-03T19:55:58.000+0000",
  "update_time" : "2024-04-03T19:55:58.000+0000",
  "org_id" : 0,
  "parent_id" : 438086664292,
  "name" : "Extreme",
  "unique_name" : "Extreme",
  "type" : "",
  "address" : "addressLine1, addressLine2, city, state, postalCode",
  "children" : [ {
    "id" : 438086664192,
    "create_time" : "2024-04-03T19:55:58.000+0000",
    "update_time" : "2024-04-03T19:55:58.000+0000",
    "org_id" : 0,
    "parent_id" : 438086664292,
    "name" : "Extreme_000",
    "unique_name" : "Extreme_000",
    "type" : "",
    "address" : "addressLine1, addressLine2, city, state, postalCode",
    "children" : [ ]
  }, {
    "id" : 438086664193,
    "create_time" : "2024-04-03T19:55:58.000+0000",
    "update_time" : "2024-04-03T19:55:58.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1OCwiZXhwIjoxNzEyNzc4OTU4fQ.cf3WHDGd6sEOvG5g6Q1meHkvycrNm8mFvwV_ruGdazs' \
    -H 'Content-Type: application/json'

Device

List devices

GET /devices

Request Parameters

Parameter Description

page

Page number

limit

Page size

locationId

Location id

connected

The device connect status

adminStates

The device admin manage status

macAddresses

The device mac addresses

sns

The device serial numbers

hostnames

The device hostnames

sortField

The device sort field

order

The device sort order

views

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

fields

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

deviceTypes

The device types

nullField

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

locationIds

The location IDs

configMismatch

Config audit status(MATCHED or UNMATCHED)

thread0_eui64

Thread router EUI64

thread0_ext_mac

Thread router extended MAC address

HTTP Request

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

Response Fields

Path Type Description

page

Number

The current page number.

count

Number

The element count of the current page.

total_pages

Number

The total page number based on request page size.

total_count

Number

The total element count.

data[].id

Number

The device ID.

data[].create_time

String

The create time.

data[].update_time

String

The last update time.

data[].org_id

Number

The organization identifier, valid when enabling HIQ feature.

data[].serial_number

String

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

data[].service_tag

String

The device service tag, valid for all HAC devices.

data[].mac_address

String

The The device MAC address.

data[].device_function

String

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

data[].product_type

String

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

data[].hostname

String

The device hostname.

data[].ip_address

String

The device IPv4 address.

data[].software_version

String

The device OS software version.

data[].device_admin_state

String

The device admin state.

data[].connected

Boolean

The device connection status.

data[].last_connect_time

String

The device last connect time

data[].network_policy_name

String

The device network policy name

data[].network_policy_id

Number

The device network policy ID

data[].primary_ntp_server_address

String

The primary NTP server address of the device

data[].primary_dns_server_address

String

The primary DNS server address of the device

data[].subnet_mask

String

The subnet mask of the device

data[].default_gateway

String

The default gateway of device

data[].ipv6_address

String

The ipv6 address of the device

data[].ipv6_netmask

Number

The ipv6 netmask of the device

data[].simulated

Boolean

Device is simulated or not

data[].display_version

String

The device display version

data[].active_clients

Number

The active clients for the device

data[].location_id

Number

The device location ID

data[].locations

Array

The device detailed location

data[].lldp_cdp_infos

Array

The device LLDP/CDP information

data[].country_code

Number

The assigned country code for the device

data[].description

String

The device description

data[].system_up_time

Number

The system up time for the device

data[].config_mismatch

Boolean

Config audit status(MATCHED or UNMATCHED)

data[].managed_by

String

The managed application for device)

data[].thread0_eui64

String

Thread router EUI64

data[].thread0_ext_mac

String

Thread router extended MAC address

HTTP Response

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

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

cURL Request

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

List Digital Twin Products

GET /devices/digital-twin

Request Parameters

Parameter Description

page

Page number

limit

Page size

makes

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

models

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

HTTP Request

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

Response Fields

Path Type Description

page

Number

The current page number

count

Number

The element count of the current page

total_pages

Number

The total page number based on request page size

total_count

Number

The total element count

data[].make

String

The Digital Twin device make.

data[].model

String

The Digital Twin device model.

data[].os_type

String

The OS Type of the Digital Twin device.

data[].os_versions

Array

The supported OS versions of the Digital Twin device.

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
RateLimit-Remaining: 7311
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: 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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2OSwiZXhwIjoxNzEyNzc4OTY5fQ.v2RmPp2TvEZ1L7eR5ZSDdzR46gvMKYBbmSZWXWUUTNY' \
    -H 'Content-Type: application/json'

Get device iBeacon

GET /devices/{id}/ibeacon

Path Parameters

Table 18. /devices/{id}/ibeacon
Parameter	Description
`id`	Device ID

HTTP Request

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

Response Fields

Path Type Description

enabled

Boolean

Whether to enable the device beacon

device_id

Number

The device ID

major

Number

Identification of a subset of beacons in a venue.

minor

Number

Identification of a beacon in a specific location.

power

Number

The transmission power in dBm.

enable_monitoring

Boolean

Whether to enable monitoring

HTTP Response

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

{
  "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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MCwiZXhwIjoxNzEyNzc4OTcwfQ.FbJbSLBWjWjJ6mw7Zupm7Xl4_VK0vjUuup983Hcgb8M' \
    -H 'Content-Type: application/json'

Update device-level iBeacon settings

PUT /devices/ibeacon

HTTP Request

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

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

Request Fields

Path Type Description

device_ids

Array

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

enabled

Boolean

Whether to enable the device beacon

major

Number

Identification of a subset of beacons in a venue.

minor

Number

Identification of a beacon in a specific location.

power

Number

The transmission power in dBm.

enable_monitoring

Boolean

Whether to enable monitoring

HTTP Response

HTTP/1.1 200 OK
RateLimit-Remaining: 7264
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/ibeacon' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MSwiZXhwIjoxNzEyNzc4OTcxfQ.hpl3caNrvOJgrep7qQPPcsCt3T8H6dsqBT8ZbbDR884' \
    -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

devices.ids

Array

The device ID list.

clis

Array

The CLI list.

HTTP Request

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

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

Response Fields

Path Type Description

device_cli_outputs

Object

device ID → CLI outputs

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Remaining: 7266
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

{
  "device_cli_outputs" : { }
}

cURL Request

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

Delete devices

Delete devices by the given device ID list.

POST /devices/:delete

Request Fields

Path Type Description

ids[]

Array

The device ID list.

HTTP Request

POST /devices/:delete HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MSwiZXhwIjoxNzEyNzc4OTcxfQ.hpl3caNrvOJgrep7qQPPcsCt3T8H6dsqBT8ZbbDR884
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: 7273

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/:delete' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MSwiZXhwIjoxNzEyNzc4OTcxfQ.hpl3caNrvOJgrep7qQPPcsCt3T8H6dsqBT8ZbbDR884' \
    -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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2OSwiZXhwIjoxNzEyNzc4OTY5fQ.v2RmPp2TvEZ1L7eR5ZSDdzR46gvMKYBbmSZWXWUUTNY
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
RateLimit-Remaining: 7309
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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2OSwiZXhwIjoxNzEyNzc4OTY5fQ.v2RmPp2TvEZ1L7eR5ZSDdzR46gvMKYBbmSZWXWUUTNY' \
    -H 'Content-Type: application/json' \
    -d '{
  "ids" : [ 438086664193, 438086664194, 438086664195 ]
}'

Onboard devices

POST /devices/:onboard

Request Fields

Path Type Description

extreme.sns

Array

The serial numbers of Extreme/Aerohive devices to onboard.

exos.sns

Array

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

voss.sns

Array

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

wing.sn_to_mac

Object

The serial number to MAC address mapping.

dell.sn_to_st

Object

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

dt.dts

Array

The Digital Twin devices to onboard.

HTTP Request

POST /devices/:onboard HTTP/1.1
Host: api.extremecloudiq.com
Content-Length: 450
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MSwiZXhwIjoxNzEyNzc4OTcxfQ.hpl3caNrvOJgrep7qQPPcsCt3T8H6dsqBT8ZbbDR884
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: 7270
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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MSwiZXhwIjoxNzEyNzc4OTcxfQ.hpl3caNrvOJgrep7qQPPcsCt3T8H6dsqBT8ZbbDR884' \
    -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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2OSwiZXhwIjoxNzEyNzc4OTY5fQ.v2RmPp2TvEZ1L7eR5ZSDdzR46gvMKYBbmSZWXWUUTNY
Content-Type: application/json
Content-Length: 2216

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

Request Parameters

Parameter Description

async

Whether running this request as async or not

Request Fields

Path Type Description

extreme[].serial_number

String

The serial number of Extreme/Aerohive device.

extreme[].location.location_id

Number

The assigned location ID, it must be FLOOR type.

extreme[].location.x

Number

The horizontal value in the floor map.

extreme[].location.y

Number

The vertical value in the floor map.

extreme[].location.latitude

Number

The latitude in the geography.

extreme[].location.longitude

Number

The longitude in the geography.

extreme[].network_policy_id

Number

The assigned network policy id.

extreme[].hostname

String

The assigned device hostname.

exos[].serial_number

String

The serial number of ExtremeXOS (EXOS) device.

exos[].location.location_id

Number

The assigned location ID, it must be FLOOR type.

exos[].location.x

Number

The horizontal value in the floor map.

exos[].location.y

Number

The vertical value in the floor map.

exos[].location.latitude

Number

The latitude in the geography.

exos[].location.longitude

Number

The longitude in the geography.

exos[].network_policy_id

Number

The assigned network policy id.

exos[].hostname

String

The assigned device hostname.

voss[].serial_number

String

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

voss[].location.location_id

Number

The assigned location ID, it must be FLOOR type.

voss[].location.x

Number

The horizontal value in the floor map.

voss[].location.y

Number

The vertical value in the floor map.

voss[].location.latitude

Number

The latitude in the geography.

voss[].location.longitude

Number

The longitude in the geography.

voss[].network_policy_id

Number

The assigned network policy id.

voss[].hostname

String

The assigned device hostname.

wing[].serial_number

String

The serial number of ExtremeWireless (WiNG) device.

wing[].mac_address

String

The mac address of ExtremeWireless (WiNG) device.

wing[].location.location_id

Number

The assigned location ID, it must be FLOOR type.

wing[].location.x

Number

The horizontal value in the floor map.

wing[].location.y

Number

The vertical value in the floor map.

wing[].location.latitude

Number

The latitude in the geography.

wing[].location.longitude

Number

The longitude in the geography.

wing[].network_policy_id

Number

The assigned network policy id.

wing[].hostname

String

The assigned device hostname.

dell[].serial_number

String

The serial number of Dell device.

dell[].service_tag

String

The service tag of Dell device.

dell[].location.location_id

Number

The assigned location ID, it must be FLOOR type.

dell[].location.x

Number

The horizontal value in the floor map.

dell[].location.y

Number

The vertical value in the floor map.

dell[].location.latitude

Number

The latitude in the geography.

dell[].location.longitude

Number

The longitude in the geography.

dell[].network_policy_id

Number

The assigned network policy id.

dell[].hostname

String

The assigned device hostname.

dt[].digital_twin_device.make

String

The Digital Twin device make.

dt[].digital_twin_device.model

String

The Digital Twin device model.

dt[].digital_twin_device.os_type

String

The OS Type of the Digital Twin device.

dt[].digital_twin_device.os_version

String

The supported OS versions of the Digital Twin device.

dt[].location.location_id

Number

The assigned location ID, it must be FLOOR type.

dt[].location.x

Number

The horizontal value in the floor map.

dt[].location.y

Number

The vertical value in the floor map.

dt[].location.latitude

Number

The latitude in the geography.

dt[].location.longitude

Number

The longitude in the geography.

dt[].network_policy_id

Number

The assigned network policy id.

dt[].hostname

String

The assigned device hostname.

unmanaged

Boolean

Whether to unmanage the devices.

HTTP Response

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

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

Response Fields

Path Type Description

success_devices[].serial_number

String

The serial number of success device.

success_devices[].device_id

Number

The id of device.

failure_devices[].serial_number

String

The serial number of failure device.

failure_devices[].error

String

The onboard error code

cURL Request

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

Advanced onboard devices asynchronously

POST /devices/:advanced-onboard

HTTP Request

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

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

Request Parameters

Parameter Description

async

Whether running this request as async or not

Request Fields

Path Type Description

extreme[].serial_number

String

The serial number of Extreme/Aerohive device.

extreme[].location.location_id

Number

The assigned location ID, it must be FLOOR type.

extreme[].location.x

Number

The horizontal value in the floor map.

extreme[].location.y

Number

The vertical value in the floor map.

extreme[].location.latitude

Number

The latitude in the geography.

extreme[].location.longitude

Number

The longitude in the geography.

extreme[].network_policy_id

Number

The assigned network policy id.

extreme[].hostname

String

The assigned device hostname.

exos[].serial_number

String

The serial number of ExtremeXOS (EXOS) device.

exos[].location.location_id

Number

The assigned location ID, it must be FLOOR type.

exos[].location.x

Number

The horizontal value in the floor map.

exos[].location.y

Number

The vertical value in the floor map.

exos[].location.latitude

Number

The latitude in the geography.

exos[].location.longitude

Number

The longitude in the geography.

exos[].network_policy_id

Number

The assigned network policy id.

exos[].hostname

String

The assigned device hostname.

voss[].serial_number

String

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

voss[].location.location_id

Number

The assigned location ID, it must be FLOOR type.

voss[].location.x

Number

The horizontal value in the floor map.

voss[].location.y

Number

The vertical value in the floor map.

voss[].location.latitude

Number

The latitude in the geography.

voss[].location.longitude

Number

The longitude in the geography.

voss[].network_policy_id

Number

The assigned network policy id.

voss[].hostname

String

The assigned device hostname.

wing[].serial_number

String

The serial number of ExtremeWireless (WiNG) device.

wing[].mac_address

String

The mac address of ExtremeWireless (WiNG) device.

wing[].location.location_id

Number

The assigned location ID, it must be FLOOR type.

wing[].location.x

Number

The horizontal value in the floor map.

wing[].location.y

Number

The vertical value in the floor map.

wing[].location.latitude

Number

The latitude in the geography.

wing[].location.longitude

Number

The longitude in the geography.

wing[].network_policy_id

Number

The assigned network policy id.

wing[].hostname

String

The assigned device hostname.

dell[].serial_number

String

The serial number of Dell device.

dell[].service_tag

String

The service tag of Dell device.

dell[].location.location_id

Number

The assigned location ID, it must be FLOOR type.

dell[].location.x

Number

The horizontal value in the floor map.

dell[].location.y

Number

The vertical value in the floor map.

dell[].location.latitude

Number

The latitude in the geography.

dell[].location.longitude

Number

The longitude in the geography.

dell[].network_policy_id

Number

The assigned network policy id.

dell[].hostname

String

The assigned device hostname.

dt[].digital_twin_device.make

String

The Digital Twin device make.

dt[].digital_twin_device.model

String

The Digital Twin device model.

dt[].digital_twin_device.os_type

String

The OS Type of the Digital Twin device.

dt[].digital_twin_device.os_version

String

The supported OS versions of the Digital Twin device.

dt[].location.location_id

Number

The assigned location ID, it must be FLOOR type.

dt[].location.x

Number

The horizontal value in the floor map.

dt[].location.y

Number

The vertical value in the floor map.

dt[].location.latitude

Number

The latitude in the geography.

dt[].location.longitude

Number

The longitude in the geography.

dt[].network_policy_id

Number

The assigned network policy id.

dt[].hostname

String

The assigned device hostname.

unmanaged

Boolean

Whether to unmanage the devices.

HTTP Response

HTTP/1.1 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: 7272

cURL Request

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

Reboot devices

POST /devices/:reboot

Request Fields

Path Type Description

ids

Array

The device ID list.

HTTP Request

POST /devices/:reboot HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MSwiZXhwIjoxNzEyNzc4OTcxfQ.hpl3caNrvOJgrep7qQPPcsCt3T8H6dsqBT8ZbbDR884
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: 7274

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/:reboot' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MSwiZXhwIjoxNzEyNzc4OTcxfQ.hpl3caNrvOJgrep7qQPPcsCt3T8H6dsqBT8ZbbDR884' \
    -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

ids

Array

The device ID list.

HTTP Request

POST /devices/:unmanage HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2OSwiZXhwIjoxNzEyNzc4OTY5fQ.v2RmPp2TvEZ1L7eR5ZSDdzR46gvMKYBbmSZWXWUUTNY
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/:unmanage' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2OSwiZXhwIjoxNzEyNzc4OTY5fQ.v2RmPp2TvEZ1L7eR5ZSDdzR46gvMKYBbmSZWXWUUTNY' \
    -H 'Content-Type: application/json' \
    -d '{
  "ids" : [ 438086664193, 438086664194, 438086664195 ]
}'

Get one device detail

GET /devices/{id}

Path parameters

Table 19. /devices/{id}
Parameter	Description
`id`	Device ID

Request Parameters

Parameter Description

views

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

fields

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

HTTP Request

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

Response Fields

Path Type Description

id

Number

The device ID.

create_time

String

The create time.

update_time

String

The last update time.

org_id

Number

The organization identifier, valid when enabling HIQ feature.

serial_number

String

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

service_tag

String

The device service tag, valid for all HAC devices.

mac_address

String

The The device MAC address.

device_function

String

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

product_type

String

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

hostname

String

The device hostname.

ip_address

String

The device IPv4 address.

software_version

String

The device OS software version.

device_admin_state

String

The device admin state.

connected

Boolean

The device connection status.

last_connect_time

String

The device last connect time.

network_policy_name

String

The device network policy name

network_policy_id

Number

The device network policy ID

primary_ntp_server_address

String

The primary NTP server address of the device

primary_dns_server_address

String

The primary DNS server address of the device

subnet_mask

String

The subnet mask of the device

default_gateway

String

The default gateway of device

ipv6_address

String

The ipv6 address of the device

ipv6_netmask

Number

The ipv6 netmask of the device

simulated

Boolean

Device is simulated or not

display_version

String

The device display version

active_clients

Number

The active clients for the device

location_id

Number

The device location ID

locations

Array

The device detailed location

lldp_cdp_infos

Array

The device LLDP/CDP information

country_code

Number

The device assigned country code

description

String

The device description

config_mismatch

Boolean

Config audit status(MATCHED or UNMATCHED)

managed_by

String

The managed application for the device

thread0_eui64

String

Thread router EUI64

thread0_ext_mac

String

Thread router extended MAC address

HTTP Response

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

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

cURL Request

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

Delete device

Delete one device.

DELETE /devices/{id}

Path parameters

Table 20. /devices/{id}
Parameter	Description
`id`	Device ID

HTTP Request

DELETE /devices/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MCwiZXhwIjoxNzEyNzc4OTcwfQ.FbJbSLBWjWjJ6mw7Zupm7Xl4_VK0vjUuup983Hcgb8M
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: 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/438086664193' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MCwiZXhwIjoxNzEyNzc4OTcwfQ.FbJbSLBWjWjJ6mw7Zupm7Xl4_VK0vjUuup983Hcgb8M' \
    -H 'Content-Type: application/json'

Send CLI to one device

Send CLI to one device.

POST /devices/{id}/:cli

Path parameters

Table 21. /devices/{id}/:cli
Parameter	Description
`id`	Device ID

Request Fields

Path Type Description

[]

Array

The request CLIs

HTTP Request

POST /devices/438086664193/:cli HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MCwiZXhwIjoxNzEyNzc4OTcwfQ.FbJbSLBWjWjJ6mw7Zupm7Xl4_VK0vjUuup983Hcgb8M
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: 7285

{
  "device_cli_outputs" : { }
}

cURL Request

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

Change status to Managed for one device

Change device management status to Managed status.

POST /devices/{id}/:manage

Path parameters

Table 22. /devices/{id}/:manage
Parameter	Description
`id`	Device ID

HTTP Request

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

HTTP Response

HTTP/1.1 200 OK
RateLimit-Remaining: 7276
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MSwiZXhwIjoxNzEyNzc4OTcxfQ.hpl3caNrvOJgrep7qQPPcsCt3T8H6dsqBT8ZbbDR884' \
    -H 'Content-Type: application/json'

Reboot one device

POST /devices/{id}/:reboot

Path parameters

Table 23. /devices/{id}/:reboot
Parameter	Description
`id`	Device ID

HTTP Request

POST /devices/438086664193/:reboot HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2OCwiZXhwIjoxNzEyNzc4OTY4fQ.dru7wC9ewVHpyu1FTG3276tHSArFDCpYDzrrEi9FaJY
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
RateLimit-Remaining: 7313
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/438086664193/:reboot' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2OCwiZXhwIjoxNzEyNzc4OTY4fQ.dru7wC9ewVHpyu1FTG3276tHSArFDCpYDzrrEi9FaJY' \
    -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

Table 24. /devices/{id}/:unmanage
Parameter	Description
`id`	Device ID

HTTP Request

POST /devices/438086664193/:unmanage HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MCwiZXhwIjoxNzEyNzc4OTcwfQ.FbJbSLBWjWjJ6mw7Zupm7Xl4_VK0vjUuup983Hcgb8M
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: 7295

cURL Request

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

Get device alarms for one device

GET /devices/{id}/alarms

Path parameters

Table 25. /devices/{id}/alarms
Parameter	Description
`id`	Device ID

Request Parameters

Parameter Description

page

Page number

limit

Page size

startTime

The start time for query device alarms

endTime

The end time for query device alarms

HTTP Request

GET /devices/438086664193/alarms?startTime=1&endTime=2 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2OCwiZXhwIjoxNzEyNzc4OTY4fQ.dru7wC9ewVHpyu1FTG3276tHSArFDCpYDzrrEi9FaJY
Host: api.extremecloudiq.com
Content-Type: application/json

Response Fields

Path Type Description

page

Number

The current page number

count

Number

The element count of the current page

total_pages

Number

The total page number based on request page size

total_count

Number

The total element count

data[].entity_id

Number

The entity ID

data[].timestamp

Number

The timestamp alarm created

data[].severity

String

The severity of the alarm

data[].category

String

The category of the alarm

data[].device_mac

String

The device mac of the alarm

data[].client_mac

String

The client mac of the alarm

data[].description

String

The alarm description

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

{
  "page" : 2,
  "count" : 3,
  "total_pages" : 3,
  "total_count" : 8,
  "data" : [ {
    "entity_id" : 1,
    "timestamp" : 1712174168000,
    "severity" : "Major",
    "category" : "test-cat-1",
    "device_mac" : "SKHMPMLXNZNO",
    "client_mac" : "",
    "description" : "test-desc1"
  }, {
    "entity_id" : 2,
    "timestamp" : 1712174168000,
    "severity" : "Major",
    "category" : "test-cat-2",
    "device_mac" : "ZSZDFYGHZRCR",
    "client_mac" : "",
    "description" : "test-desc2"
  }, {
    "entity_id" : 3,
    "timestamp" : 1712174168000,
    "severity" : "Major",
    "category" : "test-cat-3",
    "device_mac" : "KVLQHVNACUYF",
    "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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2OCwiZXhwIjoxNzEyNzc4OTY4fQ.dru7wC9ewVHpyu1FTG3276tHSArFDCpYDzrrEi9FaJY' \
    -H 'Content-Type: application/json'

Get device CPU/memory usage for one device

GET /devices/{id}/history/cpu-mem

Path parameters

Table 26. /devices/{id}/history/cpu-mem
Parameter	Description
`id`	Device ID

Request Parameters

Parameter Description

startTime

The start time for cpu and memory aggregate

endTime

The end time for cpu and memory aggregate

interval

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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2OSwiZXhwIjoxNzEyNzc4OTY5fQ.v2RmPp2TvEZ1L7eR5ZSDdzR46gvMKYBbmSZWXWUUTNY
Content-Type: application/json

Response Fields

Path Type Description

[].average_cpu

Number

The average cpu

[].average_memory

Number

The average memory

[].timestamp

Number

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
RateLimit-Remaining: 7304
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

[ {
  "average_cpu" : 1,
  "average_memory" : 1,
  "timestamp" : 1712174169000
}, {
  "average_cpu" : 2,
  "average_memory" : 2,
  "timestamp" : 1712174169000
} ]

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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2OSwiZXhwIjoxNzEyNzc4OTY5fQ.v2RmPp2TvEZ1L7eR5ZSDdzR46gvMKYBbmSZWXWUUTNY' \
    -H 'Content-Type: application/json'

Change hostname for one device

PUT /devices/{id}/hostname

Path parameters

Table 27. /devices/{id}/hostname
Parameter	Description
`id`	Device ID

Request Parameters

Parameter Description

hostname

The new hostname

HTTP Request

PUT /devices/438086664193/hostname HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MSwiZXhwIjoxNzEyNzc4OTcxfQ.hpl3caNrvOJgrep7qQPPcsCt3T8H6dsqBT8ZbbDR884
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
RateLimit-Remaining: 7279
Expires: 0
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/438086664193/hostname' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MSwiZXhwIjoxNzEyNzc4OTcxfQ.hpl3caNrvOJgrep7qQPPcsCt3T8H6dsqBT8ZbbDR884' \
    -H 'Content-Type: application/json' \
    -d 'hostname=hostname_001'

Get location for one device

GET /devices/{id}/location

Path parameters

Table 28. /devices/{id}/location
Parameter	Description
`id`	Device ID

HTTP Request

GET /devices/438086664193/location HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MSwiZXhwIjoxNzEyNzc4OTcxfQ.hpl3caNrvOJgrep7qQPPcsCt3T8H6dsqBT8ZbbDR884
Content-Type: application/json

Response Fields

Path Type Description

location_id

Number

The assigned location ID.

create_time

String

The timestamp when the device assigned to the location.

update_time

String

The timestamp when the location info was last updated.

org_id

Number

The organization ID.

parent_id

Number

The parent location ID.

location_name

String

The location name.

location_unique_name

String

The unique location name.

location_type

String

The address for the location.

location_address

String

The address for the location.

x

Number

The horizontal value in the floor map.

y

Number

The vertical value in the floor map.

latitude

Number

The latitude in the geography.

longitude

Number

The longitude in the geography.

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
Content-Length: 395
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

{
  "location_id" : 438086664193,
  "create_time" : "2024-04-03T19:56:11.000+0000",
  "update_time" : "2024-04-03T19:56:11.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MSwiZXhwIjoxNzEyNzc4OTcxfQ.hpl3caNrvOJgrep7qQPPcsCt3T8H6dsqBT8ZbbDR884' \
    -H 'Content-Type: application/json'

Assign location to one device

PUT /devices/{id}/location

Path parameters

Table 29. /devices/{id}/location
Parameter	Description
`id`	Device ID

Request Fields

Path Type Description

location_id

Number

The assigned location ID.

x

Number

The horizontal value in the floor map.

y

Number

The vertical value in the floor map.

latitude

Number

The vertical value in the floor map.

longitude

Number

The longitude in the geography.

HTTP Request

PUT /devices/438086664193/location HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2OCwiZXhwIjoxNzEyNzc4OTY4fQ.dru7wC9ewVHpyu1FTG3276tHSArFDCpYDzrrEi9FaJY
Host: api.extremecloudiq.com
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: 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/438086664193/location' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2OCwiZXhwIjoxNzEyNzc4OTY4fQ.dru7wC9ewVHpyu1FTG3276tHSArFDCpYDzrrEi9FaJY' \
    -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

Table 30. /devices/{id}/location
Parameter	Description
`id`	Device ID

HTTP Request

DELETE /devices/438086664193/location HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MCwiZXhwIjoxNzEyNzc4OTcwfQ.FbJbSLBWjWjJ6mw7Zupm7Xl4_VK0vjUuup983Hcgb8M
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: 7284

cURL Request

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

Get network policy for one device

GET /devices/{id}/network-policy

Path parameters

Table 31. /devices/{id}/network-policy
Parameter	Description
`id`	Device ID

HTTP Request

GET /devices/438086664193/network-policy HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2OCwiZXhwIjoxNzEyNzc4OTY4fQ.dru7wC9ewVHpyu1FTG3276tHSArFDCpYDzrrEi9FaJY
Host: api.extremecloudiq.com
Content-Type: application/json

Response Fields

Path Type Description

id

Number

The network policy ID.

create_time

String

The timestamp when the network policy was created.

update_time

String

The timestamp when the network policy was last updated.

org_id

Number

The Organization ID.

name

String

The network policy name.

description

String

The network policy description.

type

String

The network policy type.

predefined

Boolean

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: 7314
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" : "2024-04-03T19:56:08.000+0000",
  "update_time" : "2024-04-03T19:56:08.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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2OCwiZXhwIjoxNzEyNzc4OTY4fQ.dru7wC9ewVHpyu1FTG3276tHSArFDCpYDzrrEi9FaJY' \
    -H 'Content-Type: application/json'

Assign network policy to one device

PUT /devices/{id}/network-policy

Path parameters

Table 32. /devices/{id}/network-policy
Parameter	Description
`id`	Device ID

Request Parameters

Parameter Description

networkPolicyId

The network policy ID to assign

HTTP Request

PUT /devices/438086664193/network-policy HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2OSwiZXhwIjoxNzEyNzc4OTY5fQ.v2RmPp2TvEZ1L7eR5ZSDdzR46gvMKYBbmSZWXWUUTNY
Content-Type: application/json

networkPolicyId=438086664194

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: 7305
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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2OSwiZXhwIjoxNzEyNzc4OTY5fQ.v2RmPp2TvEZ1L7eR5ZSDdzR46gvMKYBbmSZWXWUUTNY' \
    -H 'Content-Type: application/json' \
    -d 'networkPolicyId=438086664194'

Revoke network policy for one device

DELETE /devices/{id}/network-policy

Path parameters

Table 33. /devices/{id}/network-policy
Parameter	Description
`id`	Device ID

HTTP Request

DELETE /devices/438086664193/network-policy HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MSwiZXhwIjoxNzEyNzc4OTcxfQ.hpl3caNrvOJgrep7qQPPcsCt3T8H6dsqBT8ZbbDR884
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
RateLimit-Remaining: 7269
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 DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MSwiZXhwIjoxNzEyNzc4OTcxfQ.hpl3caNrvOJgrep7qQPPcsCt3T8H6dsqBT8ZbbDR884' \
    -H 'Content-Type: application/json'

Device level SSID override

POST /devices/{id}/ssid/:override

Path parameters

Table 34. /devices/{id}/ssid/:override
Parameter	Description
`id`	Device ID

Request Fields

Path Type Description

ssid_id

Number

The ssid ID to override.

ssid

String

The broadcast ssid name to override. Can only override if the SSID profile is OPEN or PSK mode.

passphrase

String

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
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2OCwiZXhwIjoxNzEyNzc4OTY4fQ.dru7wC9ewVHpyu1FTG3276tHSArFDCpYDzrrEi9FaJY
Host: api.extremecloudiq.com
Content-Length: 70
Content-Type: application/json

{
  "ssid_id" : 1,
  "ssid" : "ssid0",
  "passphrase" : "BKxtQ7O7WV"
}

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: 7318
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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2OCwiZXhwIjoxNzEyNzc4OTY4fQ.dru7wC9ewVHpyu1FTG3276tHSArFDCpYDzrrEi9FaJY' \
    -H 'Content-Type: application/json' \
    -d '{
  "ssid_id" : 1,
  "ssid" : "ssid0",
  "passphrase" : "BKxtQ7O7WV"
}'

Get device level SSID status

Get device level SSID status on each wifi interface

GET /devices/{id}/ssid/status

Path parameters

Table 35. /devices/{id}/ssid/status
Parameter	Description
`id`	The device ID

HTTP Request

GET /devices/438086664193/ssid/status HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MSwiZXhwIjoxNzEyNzc4OTcxfQ.hpl3caNrvOJgrep7qQPPcsCt3T8H6dsqBT8ZbbDR884
Content-Type: application/json

Response Fields

Path Type Description

*.wifi0_enabled

Boolean

The SSID is enabled or not on wifi0 interface

*.wifi1_enabled

Boolean

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: 7268
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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MSwiZXhwIjoxNzEyNzc4OTcxfQ.hpl3caNrvOJgrep7qQPPcsCt3T8H6dsqBT8ZbbDR884' \
    -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

Table 36. /devices/{id}/ssid/status/:change
Parameter	Description
`id`	Device ID

Request Fields

Path Type Description

ssid_ids

Array

The SSID IDs to disable. If no SSID ID is given, no action will happen

if_names

Array

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

enabled

Boolean

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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2OSwiZXhwIjoxNzEyNzc4OTY5fQ.v2RmPp2TvEZ1L7eR5ZSDdzR46gvMKYBbmSZWXWUUTNY
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-Remaining: 7299
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/status/:change' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2OSwiZXhwIjoxNzEyNzc4OTY5fQ.v2RmPp2TvEZ1L7eR5ZSDdzR46gvMKYBbmSZWXWUUTNY' \
    -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

devices

Object

The devices filter

devices.ids

Array

The device ID list.

device_location

Object

The Device location assignment

device_location.location_id

Number

The assigned location ID.

device_location.x

Number

The horizontal value in the floor map.

device_location.y

Number

The vertical value in the floor map.

device_location.latitude

Number

The vertical value in the floor map.

device_location.longitude

Number

The longitude in the geography.

HTTP Request

POST /devices/location/:assign HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2OCwiZXhwIjoxNzEyNzc4OTY4fQ.dru7wC9ewVHpyu1FTG3276tHSArFDCpYDzrrEi9FaJY
Host: api.extremecloudiq.com
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
RateLimit-Remaining: 7313
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/location/:assign' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2OCwiZXhwIjoxNzEyNzc4OTY4fQ.dru7wC9ewVHpyu1FTG3276tHSArFDCpYDzrrEi9FaJY' \
    -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

ids

Array

The device ID list.

HTTP Request

POST /devices/location/:query HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2OSwiZXhwIjoxNzEyNzc4OTY5fQ.v2RmPp2TvEZ1L7eR5ZSDdzR46gvMKYBbmSZWXWUUTNY
Content-Type: application/json
Content-Length: 58

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

Response Fields

Path Type Description

*.location_id

Number

The assigned location ID.

*.create_time

String

The timestamp when the device assigned to the location.

*.update_time

String

The timestamp when the location info was last updated.

*.org_id

Number

The organization ID.

*.parent_id

Number

The parent location ID.

*.location_name

String

The location name.

*.location_unique_name

String

The unique location name.

*.location_type

String

The address for the location.

*.location_address

String

The address for the location.

*.x

Number

The horizontal value in the floor map.

*.y

Number

The vertical value in the floor map.

*.latitude

Number

The latitude in the geography.

*.longitude

Number

The longitude in the geography.

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
RateLimit-Remaining: 7301
Expires: 0
X-Content-Type-Options: nosniff
Content-Length: 446
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" : "2024-04-03T19:56:09.000+0000",
    "update_time" : "2024-04-03T19:56:09.000+0000",
    "org_id" : 0,
    "parent_id" : 0,
    "location_name" : "1st floor",
    "location_unique_name" : "Location_001_floor",
    "location_type" : "Standard",
    "location_address" : "Location address",
    "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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2OSwiZXhwIjoxNzEyNzc4OTY5fQ.v2RmPp2TvEZ1L7eR5ZSDdzR46gvMKYBbmSZWXWUUTNY' \
    -H 'Content-Type: application/json' \
    -d '{
  "ids" : [ 438086664193, 438086664194, 438086664195 ]
}'

Revoke location for multiple devices

POST /devices/location/:revoke

Request Fields

Path Type Description

ids

Array

The device ID list.

HTTP Request

POST /devices/location/:revoke HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2OSwiZXhwIjoxNzEyNzc4OTY5fQ.v2RmPp2TvEZ1L7eR5ZSDdzR46gvMKYBbmSZWXWUUTNY
Content-Type: application/json
Content-Length: 58

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

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
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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2OSwiZXhwIjoxNzEyNzc4OTY5fQ.v2RmPp2TvEZ1L7eR5ZSDdzR46gvMKYBbmSZWXWUUTNY' \
    -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

devices

Object

The devices filter

devices.ids

Array

The device ID list.

network_policy_id

Number

The assigned network policy ID

HTTP Request

POST /devices/network-policy/:assign HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MCwiZXhwIjoxNzEyNzc4OTcwfQ.FbJbSLBWjWjJ6mw7Zupm7Xl4_VK0vjUuup983Hcgb8M
Content-Type: application/json
Content-Length: 107

{
  "devices" : {
    "ids" : [ 438086664193, 438086664194, 438086664195 ]
  },
  "network_policy_id" : 1
}

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
RateLimit-Remaining: 7289
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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MCwiZXhwIjoxNzEyNzc4OTcwfQ.FbJbSLBWjWjJ6mw7Zupm7Xl4_VK0vjUuup983Hcgb8M' \
    -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

ids

Array

The device ID list.

HTTP Request

POST /devices/network-policy/:query HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2OCwiZXhwIjoxNzEyNzc4OTY4fQ.dru7wC9ewVHpyu1FTG3276tHSArFDCpYDzrrEi9FaJY
Host: api.extremecloudiq.com
Content-Type: application/json
Content-Length: 58

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

Response Fields

Path Type Description

*.location_id

Number

The assigned location ID.

*.create_time

String

The timestamp when the device assigned to the location.

*.update_time

String

The timestamp when the location info was last updated.

*.org_id

Number

The organization ID.

*.parent_id

Number

The parent location ID.

*.location_name

String

The location name.

*.location_unique_name

String

The unique location name.

*.location_type

String

The address for the location.

*.location_address

String

The address for the location.

*.x

Number

The horizontal value in the floor map.

*.y

Number

The vertical value in the floor map.

*.latitude

Number

The latitude in the geography.

*.longitude

Number

The longitude in the geography.

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
RateLimit-Remaining: 7301
Expires: 0
X-Content-Type-Options: nosniff
Content-Length: 446
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" : "2024-04-03T19:56:09.000+0000",
    "update_time" : "2024-04-03T19:56:09.000+0000",
    "org_id" : 0,
    "parent_id" : 0,
    "location_name" : "1st floor",
    "location_unique_name" : "Location_001_floor",
    "location_type" : "Standard",
    "location_address" : "Location address",
    "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.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2OSwiZXhwIjoxNzEyNzc4OTY5fQ.v2RmPp2TvEZ1L7eR5ZSDdzR46gvMKYBbmSZWXWUUTNY' \
    -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

ids

Array

The device ID list.

HTTP Request

POST /devices/network-policy/:revoke HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MSwiZXhwIjoxNzEyNzc4OTcxfQ.hpl3caNrvOJgrep7qQPPcsCt3T8H6dsqBT8ZbbDR884
Content-Type: application/json
Content-Length: 58

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

HTTP Response

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

cURL Request

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

List assigned devices for network policy

GET /devices/network-policy/{policyId}

Path parameters

Table 37. /devices/network-policy/{policyId}
Parameter	Description
`policyId`	The network policy ID

Request Parameters

Parameter Description

page

Page number

limit

Page size

HTTP Request

GET /devices/network-policy/438086664193?page=1&limit=10 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MCwiZXhwIjoxNzEyNzc4OTcwfQ.FbJbSLBWjWjJ6mw7Zupm7Xl4_VK0vjUuup983Hcgb8M
Content-Type: application/json
Content-Length: 58

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

Response Fields

Path Type Description

page

Number

The current page number.

count

Number

The element count of the current page.

total_pages

Number

The total page number based on request page size.

total_count

Number

The total element count.

data[].id

Number

The device ID.

data[].create_time

String

The create time.

data[].update_time

String

The last update time.

data[].org_id

Number

The organization identifier, valid when enabling HIQ feature.

data[].serial_number

String

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

data[].service_tag

String

The device service tag, valid for all HAC devices.

data[].mac_address

String

The The device MAC address.

data[].device_function

String

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

data[].product_type

String

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

data[].hostname

String

The device hostname.

data[].ip_address

String

The device IPv4 address.

data[].software_version

String

The device OS software version.

data[].device_admin_state

String

The device admin state.

data[].connected

Boolean

The device connection status.

data[].last_connect_time

class java.util.Date

The device last connect time.

data[].network_policy_name

String

The device network policy name

data[].network_policy_id

Number

The device network policy ID

data[].primary_ntp_server_address

String

The primary NTP server address of the device

data[].primary_dns_server_address

String

The primary DNS server address of the device

data[].subnet_mask

String

The subnet mask of the device

data[].default_gateway

String

The default gateway of device

data[].ipv6_address

String

The ipv6 address of the device

data[].ipv6_netmask

Number

The ipv6 netmask of the device

data[].simulated

Boolean

Device is simulated or not

data[].display_version

String

The device display version

data[].active_clients

Number

The active clients for the device

data[].location_id

Number

The device location ID

data[].locations

Array

The device detailed location

data[].lldp_cdp_infos

Array

The device LLDP/CDP information

data[].country_code

Number

The device assigned country code

data[].description

String

The device description

data[].config_mismatch

Boolean

Config audit status(MATCHED or UNMATCHED)

data[].managed_by

String

The managed application for the device)

data[].thread0_eui64

String

Thread router EUI64

data[].thread0_ext_mac

String

Thread router extended MAC address

HTTP Response

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

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 2,
  "total_count" : 15,
  "data" : [ {
    "id" : 1,
    "create_time" : "2024-04-03T19:56:10.000+0000",
    "update_time" : "2024-04-03T19:56:10.000+0000",
    "org_id" : 10,
    "serial_number" : "12281645370696",
    "service_tag" : "",
    "mac_address" : "1OeQPlT9Wfc5",
    "device_function" : "AP",
    "product_type" : "AP_230",
    "hostname" : "PLAN-6216E1-0",
    "ip_address" : "192.168.56.0",
    "software_version" : "8.4.10.0",
    "device_admin_state" : "MANAGED",
    "connected" : true,
    "network_policy_name" : "",
    "network_policy_id" : 0,
    "primary_dns_server_address" : "",
    "default_gateway" : "",
    "locations" : [ ],
    "country_code" : 840,
    "lldp_cdp_infos" : [ ],
    "config_mismatch" : true,
    "managed_by" : "",
    "thread0_eui64" : "",
    "thread0_ext_mac" : ""
  }, {
    "id" : 2,
    "create_time" : "2024-04-03T19:56:10.000+0000",
    "update_time" : "2024-04-03T19:56:10.000+0000",
    "org_id" : 10,
    "serial_number" : "18026483452490",
    "service_tag" : "",
    "mac_address" : "x7CmxKaUJfFU",
    "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,
    "network_policy_name" : "",
    "network_policy_id" : 0,
    "primary_dns_server_address" : "",
    "default_gateway" : "",
    "locations" : [ ],
    "country_code" : 840,
    "lldp_cdp_infos" : [ ],
    "config_mismatch" : true,
    "managed_by" : "",
    "thread0_eui64" : "",
    "thread0_ext_mac" : ""
  }, {
    "id" : 3,
    "create_time" : "2024-04-03T19:56:10.000+0000",
    "update_time" : "2024-04-03T19:56:10.000+0000",
    "org_id" : 10,
    "serial_number" : "08078989296233",
    "service_tag" : "",
    "mac_address" : "gB1YDUiWfpiv",
    "device_function" : "AP",
    "product_type" : "AP_230",
    "hostname" : "PLAN-6216E1-2",
    "ip_address" : "192.168.56.2",
    "software_version" : "8.4.10.0",
    "device_admin_state" : "MANAGED",
    "connected" : true,
    "network_policy_name" : "",
    "network_policy_id" : 0,
    "primary_dns_server_address" : "",
    "default_gateway" : "",
    "locations" : [ ],
    "country_code" : 840,
    "lldp_cdp_infos" : [ ],
    "config_mismatch" : true,
    "managed_by" : "",
    "thread0_eui64" : "",
    "thread0_ext_mac" : ""
  }, {
    "id" : 4,
    "create_time" : "2024-04-03T19:56:10.000+0000",
    "update_time" : "2024-04-03T19:56:10.000+0000",
    "org_id" : 10,
    "serial_number" : "69656478649272",
    "service_tag" : "",
    "mac_address" : "6neKaZPnXHZN",
    "device_function" : "AP",
    "product_type" : "AP_230",
    "hostname" : "PLAN-6216E1-3",
    "ip_address" : "192.168.56.3",
    "software_version" : "8.4.10.0",
    "device_admin_state" : "MANAGED",
    "connected" : true,
    "network_policy_name" : "",
    "network_policy_id" : 0,
    "primary_dns_server_address" : "",
    "default_gateway" : "",
    "locations" : [ ],
    "country_code" : 840,
    "lldp_cdp_infos" : [ ],
    "config_mismatch" : true,
    "managed_by" : "",
    "thread0_eui64" : "",
    "thread0_ext_mac" : ""
  }, {
    "id" : 5,
    "create_time" : "2024-04-03T19:56:10.000+0000",
    "update_time" : "2024-04-03T19:56:10.000+0000",
    "org_id" : 10,
    "serial_number" : "87391400646708",
    "service_tag" : "",
    "mac_address" : "OdeHJibdWtoi",
    "device_function" : "AP",
    "product_type" : "AP_230",
    "hostname" : "PLAN-6216E1-4",
    "ip_address" : "192.168.56.4",
    "software_version" : "8.4.10.0",
    "device_admin_state" : "MANAGED",
    "connected" : true,
    "network_policy_name" : "",
    "network_policy_id" : 0,
    "primary_dns_server_address" : "",
    "default_gateway" : "",
    "locations" : [ ],
    "country_code" : 840,
    "lldp_cdp_infos" : [ ],
    "config_mismatch" : true,
    "managed_by" : "",
    "thread0_eui64" : "",
    "thread0_ext_mac" : ""
  }, {
    "id" : 6,
    "create_time" : "2024-04-03T19:56:10.000+0000",
    "update_time" : "2024-04-03T19:56:10.000+0000",
    "org_id" : 10,
    "serial_number" : "81038884191180",
    "service_tag" : "",
    "mac_address" : "PDaRVGPzerRK",
    "device_function" : "AP",
    "product_type" : "AP_230",
    "hostname" : "PLAN-6216E1-5",
    "ip_address" : "192.168.56.5",
    "software_version" : "8.4.10.0",
    "device_admin_state" : "MANAGED",
    "connected" : true,
    "network_policy_name" : "",
    "network_policy_id" : 0,
    "primary_dns_server_address" : "",
    "default_gateway" : "",
    "locations" : [ ],
    "country_code" : 840,
    "lldp_cdp_infos" : [ ],
    "config_mismatch" : true,
    "managed_by" : "",
    "thread0_eui64" : "",
    "thread0_ext_mac" : ""
  }, {
    "id" : 7,
    "create_time" : "2024-04-03T19:56:10.000+0000",
    "update_time" : "2024-04-03T19:56:10.000+0000",
    "org_id" : 10,
    "serial_number" : "76725160203890",
    "service_tag" : "",
    "mac_address" : "jp2REEYajNZb",
    "device_function" : "AP",
    "product_type" : "AP_230",
    "hostname" : "PLAN-6216E1-6",
    "ip_address" : "192.168.56.6",
    "software_version" : "8.4.10.0",
    "device_admin_state" : "MANAGED",
    "connected" : true,
    "network_policy_name" : "",
    "network_policy_id" : 0,
    "primary_dns_server_address" : "",
    "default_gateway" : "",
    "locations" : [ ],
    "country_code" : 840,
    "lldp_cdp_infos" : [ ],
    "config_mismatch" : true,
    "managed_by" : "",
    "thread0_eui64" : "",
    "thread0_ext_mac" : ""
  }, {
    "id" : 8,
    "create_time" : "2024-04-03T19:56:10.000+0000",
    "update_time" : "2024-04-03T19:56:10.000+0000",
    "org_id" : 10,
    "serial_number" : "02472789487653",
    "service_tag" : "",
    "mac_address" : "VnULu3k8AOz2",
    "device_function" : "AP",
    "product_type" : "AP_230",
    "hostname" : "PLAN-6216E1-7",
    "ip_address" : "192.168.56.7",
    "software_version" : "8.4.10.0",
    "device_admin_state" : "MANAGED",
    "connected" : true,
    "network_policy_name" : "",
    "network_policy_id" : 0,
    "primary_dns_server_address" : "",
    "default_gateway" : "",
    "locations" : [ ],
    "country_code" : 840,
    "lldp_cdp_infos" : [ ],
    "config_mismatch" : true,
    "managed_by" : "",
    "thread0_eui64" : "",
    "thread0_ext_mac" : ""
  }, {
    "id" : 9,
    "create_time" : "2024-04-03T19:56:10.000+0000",
    "update_time" : "2024-04-03T19:56:10.000+0000",
    "org_id" : 10,
    "serial_number" : "61398980747128",
    "service_tag" : "",
    "mac_address" : "5HDAJQnLGuGb",
    "device_function" : "AP",
    "product_type" : "AP_230",
    "hostname" : "PLAN-6216E1-8",
    "ip_address" : "192.168.56.8",
    "software_version" : "8.4.10.0",
    "device_admin_state" : "MANAGED",
    "connected" : true,
    "network_policy_name" : "",
    "network_policy_id" : 0,
    "primary_dns_server_address" : "",
    "default_gateway" : "",
    "locations" : [ ],
    "country_code" : 840,
    "lldp_cdp_infos" : [ ],
    "config_mismatch" : true,
    "managed_by" : "",
    "thread0_eui64" : "",
    "thread0_ext_mac" : ""
  }, {
    "id" : 10,
    "create_time" : "2024-04-03T19:56:10.000+0000",
    "update_time" : "2024-04-03T19:56:10.000+0000",
    "org_id" : 10,
    "serial_number" : "18329630054990",
    "service_tag" : "",
    "mac_address" : "DI5kJCmpYuD4",
    "device_function" : "AP",
    "product_type" : "AP_230",
    "hostname" : "PLAN-6216E1-9",
    "ip_address" : "192.168.56.9",
    "software_version" : "8.4.10.0",
    "device_admin_state" : "MANAGED",
    "connected" : true,
    "network_policy_name" : "",
    "network_policy_id" : 0,
    "primary_dns_server_address" : "",
    "default_gateway" : "",
    "locations" : [ ],
    "country_code" : 840,
    "lldp_cdp_infos" : [ ],
    "config_mismatch" : true,
    "managed_by" : "",
    "thread0_eui64" : "",
    "thread0_ext_mac" : ""
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/network-policy/438086664193?page=1&limit=10' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MCwiZXhwIjoxNzEyNzc4OTcwfQ.FbJbSLBWjWjJ6mw7Zupm7Xl4_VK0vjUuup983Hcgb8M' \
    -H 'Content-Type: application/json' \
    -d '{
  "ids" : [ 438086664193, 438086664194, 438086664195 ]
}'

Change multiple devices OS mode

POST /devices/os/:change

Request Fields

Path Type Description

device_ids

Array

The one or multiple device IDs to change the OS mode. Must be all AP or Switches in the same list

target_os

String

The target OS mode to change to, for AP: only WiNG is supported, for Switch: EXOS or VOSS

HTTP Request

POST /devices/os/:change HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MCwiZXhwIjoxNzEyNzc4OTcwfQ.FbJbSLBWjWjJ6mw7Zupm7Xl4_VK0vjUuup983Hcgb8M
Content-Type: application/json
Content-Length: 56

{
  "device_ids" : [ 1, 2, 3 ],
  "target_os" : "WiNG"
}

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/os/:change' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MCwiZXhwIjoxNzEyNzc4OTcwfQ.FbJbSLBWjWjJ6mw7Zupm7Xl4_VK0vjUuup983Hcgb8M' \
    -H 'Content-Type: application/json' \
    -d '{
  "device_ids" : [ 1, 2, 3 ],
  "target_os" : "WiNG"
}'

Assign radius proxy to multiple devices

PUT /devices/radius-proxy/:assgin

Request Parameters

Parameter Description

ids

The device IDs

radiusProxyId

The RADIUS proxy ID to assign

HTTP Request

PUT /devices/radius-proxy/:assign HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MCwiZXhwIjoxNzEyNzc4OTcwfQ.FbJbSLBWjWjJ6mw7Zupm7Xl4_VK0vjUuup983Hcgb8M
Content-Type: application/json

ids=438086664193&ids=438086664194&ids=438086664195&radiusProxyId=438086664193

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: 7292
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/radius-proxy/:assign' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MCwiZXhwIjoxNzEyNzc4OTcwfQ.FbJbSLBWjWjJ6mw7Zupm7Xl4_VK0vjUuup983Hcgb8M' \
    -H 'Content-Type: application/json' \
    -d 'ids=438086664193&ids=438086664194&ids=438086664195&radiusProxyId=438086664193'

Revoke radius proxy for multiple devices

DELETE /devices/radius-proxy/:revoke

Request Parameters

Parameter Description

ids

The device IDs

HTTP Request

DELETE /devices/radius-proxy/:revoke HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MSwiZXhwIjoxNzEyNzc4OTcxfQ.hpl3caNrvOJgrep7qQPPcsCt3T8H6dsqBT8ZbbDR884
Content-Type: application/json

HTTP Response

HTTP/1.1 200 OK
RateLimit-Remaining: 7275
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
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/radius-proxy/:revoke' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MSwiZXhwIjoxNzEyNzc4OTcxfQ.hpl3caNrvOJgrep7qQPPcsCt3T8H6dsqBT8ZbbDR884' \
    -H 'Content-Type: application/json'

List device status summary

GET /device/stats

Request Parameters

Parameter Description

locationId

The location id

HTTP Request

GET /devices/stats?locationId=438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2OSwiZXhwIjoxNzEyNzc4OTY5fQ.v2RmPp2TvEZ1L7eR5ZSDdzR46gvMKYBbmSZWXWUUTNY
Content-Type: application/json

Response Fields

Path Type Description

total_device_count

Number

The total device count

managed_device_count

Number

The managed device count

connected_device_count

Number

The connected device count

HTTP Response

HTTP/1.1 200 OK
RateLimit-Remaining: 7298
Pragma: no-cache
Content-Length: 97
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

{
  "total_device_count" : 200,
  "managed_device_count" : 100,
  "connected_device_count" : 12
}

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/stats?locationId=438086664193' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2OSwiZXhwIjoxNzEyNzc4OTY5fQ.v2RmPp2TvEZ1L7eR5ZSDdzR46gvMKYBbmSZWXWUUTNY' \
    -H 'Content-Type: application/json'

Assign country code on multiple devices

POST /devices/{countryCode}/:assign

Request Fields

Path Type Description

devices

Object

The devices filter

devices.ids

Array

The device ID list

country_code

String

The country code to assign

HTTP Request

POST /devices/country-code/:assign HTTP/1.1
Host: api.extremecloudiq.com
Content-Length: 120
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MCwiZXhwIjoxNzEyNzc4OTcwfQ.FbJbSLBWjWjJ6mw7Zupm7Xl4_VK0vjUuup983Hcgb8M
Content-Type: application/json

{
  "devices" : {
    "ids" : [ 438086664193, 438086664194, 438086664195 ]
  },
  "country_code" : "UNITED_STATES_840"
}

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/country-code/:assign' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MCwiZXhwIjoxNzEyNzc4OTcwfQ.FbJbSLBWjWjJ6mw7Zupm7Xl4_VK0vjUuup983Hcgb8M' \
    -H 'Content-Type: application/json' \
    -d '{
  "devices" : {
    "ids" : [ 438086664193, 438086664194, 438086664195 ]
  },
  "country_code" : "UNITED_STATES_840"
}'

Change description for one device

PUT /devices/{id}/description

Path parameters

Table 38. /devices/{id}/description
Parameter	Description
`id`	Device ID

Request Body

Description with length 1 - 64

HTTP Request

PUT /devices/438086664193/description HTTP/1.1
Content-Length: 30
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MSwiZXhwIjoxNzEyNzc4OTcxfQ.hpl3caNrvOJgrep7qQPPcsCt3T8H6dsqBT8ZbbDR884
Content-Type: text/plain

Description with length 1 - 64

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/438086664193/description' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MSwiZXhwIjoxNzEyNzc4OTcxfQ.hpl3caNrvOJgrep7qQPPcsCt3T8H6dsqBT8ZbbDR884' \
    -H 'Content-Type: text/plain' \
    -d 'Description with length 1 - 64'

Get CLI Response from devices asynchronously

POST /devices/:cli

Request Fields

Path Type Description

devices.ids

Array

The selected target devices

clis

Array

The one or multiple CLIs to send

HTTP Request

POST /devices/:cli?async=true HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MCwiZXhwIjoxNzEyNzc4OTcwfQ.FbJbSLBWjWjJ6mw7Zupm7Xl4_VK0vjUuup983Hcgb8M
Content-Type: application/json
Content-Length: 124

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

Request Parameters

Parameter Description

async

Whether running this request as async or not

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
RateLimit-Remaining: 7282
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/:cli?async=true' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MCwiZXhwIjoxNzEyNzc4OTcwfQ.FbJbSLBWjWjJ6mw7Zupm7Xl4_VK0vjUuup983Hcgb8M' \
    -H 'Content-Type: application/json' \
    -d '{
  "devices" : {
    "ids" : [ 438086664193, 438086664194, 438086664195 ]
  },
  "clis" : [ "show version", "show mgmt" ]
}'

Get device installation report

GET /devices/{id}/installation-report

Path Parameters

Table 39. /devices/{id}/installation-report
Parameter	Description
`id`	Device ID

HTTP Request

GET /devices/438086664193/installation-report HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MCwiZXhwIjoxNzEyNzc4OTcwfQ.FbJbSLBWjWjJ6mw7Zupm7Xl4_VK0vjUuup983Hcgb8M
Content-Type: application/json

Response Fields

Path Type Description

onboarded

Boolean

Device onboard status

location_name

String

Location Unique name

network_policy_name

String

Network policy name

device_template_name

String

Assigned device template name

ip_address

String

Device IPv4 address

default_gateway

String

Device default gateway

ntp_server

String

ntp server address

dns_server

String

dns server address

enable_poe

Boolean

Enabling PoE

xiq_connectivity

Boolean

Cloud or Locally managed indicator. True means Cloud managed device

image_count

Number

The number of the device gallery images.

image_names

Array

The names for the device gallery images.

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

{
  "onboarded" : true,
  "location_name" : "Amazon",
  "network_policy_name" : "test-nwp",
  "device_template_name" : "test-temp",
  "ip_address" : "192.168.56.1",
  "default_gateway" : "10.10.10.10",
  "ntp_server" : "255.255.255.255",
  "dns_server" : "255.255.255.255",
  "enable_poe" : true,
  "xiq_connectivity" : true,
  "image_count" : 0,
  "image_names" : [ ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/438086664193/installation-report' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MCwiZXhwIjoxNzEyNzc4OTcwfQ.FbJbSLBWjWjJ6mw7Zupm7Xl4_VK0vjUuup983Hcgb8M' \
    -H 'Content-Type: application/json'

Download device gallery image

GET /devices/{id}/gallery-image

Path Parameters

Table 40. /devices/{id}/gallery-image
Parameter	Description
`id`	Device ID

Request Parameters

Parameter Description

imageName

The image name

HTTP Request

GET /devices/438086664193/gallery-image?imageName=images.png HTTP/1.1
Host: api.extremecloudiq.com
Accept: application/octet-stream
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2OSwiZXhwIjoxNzEyNzc4OTY5fQ.v2RmPp2TvEZ1L7eR5ZSDdzR46gvMKYBbmSZWXWUUTNY
Content-Type: application/octet-stream
Content-Disposition: form-data; name="attachment"; filename="filename"

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
Content-Length: 10
RateLimit-Limit: 7500;w=3600
RateLimit-Remaining: 7300
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Disposition: attachment; filename="images.png"
Accept-Ranges: bytes
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Content-Type: application/octet-stream

images.png

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/438086664193/gallery-image?imageName=images.png' -i -X GET \
    -H 'Accept: application/octet-stream' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2OSwiZXhwIjoxNzEyNzc4OTY5fQ.v2RmPp2TvEZ1L7eR5ZSDdzR46gvMKYBbmSZWXWUUTNY' \
    -H 'Content-Type: application/octet-stream' \
    -H 'Content-Disposition: form-data; name="attachment"; filename="filename"'

Create Bounce Device Port

POST /devices/{id}/bounce-port

Request fields

Path Type Description

port_number

String

The port number of the device (eg. 1,2, ..)

bounce_port_reason

String

The reason to bounce the port

device_id

Number

The device id

HTTP Request

POST /devices/438086664193/bounce-port HTTP/1.1
Host: api.extremecloudiq.com
Content-Length: 77
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MCwiZXhwIjoxNzEyNzc4OTcwfQ.FbJbSLBWjWjJ6mw7Zupm7Xl4_VK0vjUuup983Hcgb8M
Content-Type: application/json

{
  "device_id" : 1,
  "port_number" : "1",
  "bounce_port_reason" : "ABCD"
}

Response Fields

Path Type Description

data.status

Number

The status of response

data.request_id

Number

The request id of response

data.results[].status

Number

The status of Operation Result response

data.results[].message

String

The message of the response

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
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: 136

{
  "data" : {
    "status" : 2,
    "request_id" : 2,
    "results" : [ {
      "status" : 1,
      "message" : "AAABBCC"
    } ]
  }
}

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/438086664193/bounce-port' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MCwiZXhwIjoxNzEyNzc4OTcwfQ.FbJbSLBWjWjJ6mw7Zupm7Xl4_VK0vjUuup983Hcgb8M' \
    -H 'Content-Type: application/json' \
    -d '{
  "device_id" : 1,
  "port_number" : "1",
  "bounce_port_reason" : "ABCD"
}'

Device Thread Commissioner Start

POST /devices/{id}/thread/commissioner/:start

Path parameters

Table 41. /devices/{id}/thread/commissioner/:start
Parameter	Description
`id`	Device ID

Request Fields

Path Type Description

device_id

Number

The device id.

interface_name

String

The IoT interface on which to start the Commissioner. The default is iot0.

comm_timeout

Number

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

HTTP Request

POST /devices/438086664193/thread/commissioner/:start HTTP/1.1
Content-Length: 74
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2OSwiZXhwIjoxNzEyNzc4OTY5fQ.v2RmPp2TvEZ1L7eR5ZSDdzR46gvMKYBbmSZWXWUUTNY
Content-Type: application/json

{
  "device_id" : 1,
  "comm_timeout" : 120,
  "interface_name" : "iot0"
}

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: 7308
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/thread/commissioner/:start' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE2OSwiZXhwIjoxNzEyNzc4OTY5fQ.v2RmPp2TvEZ1L7eR5ZSDdzR46gvMKYBbmSZWXWUUTNY' \
    -H 'Content-Type: application/json' \
    -d '{
  "device_id" : 1,
  "comm_timeout" : 120,
  "interface_name" : "iot0"
}'

Device Thread Commissioner Stop

POST /devices/{id}/thread/commissioner/:stop

Path parameters

Table 42. /devices/{id}/thread/commissioner/:stop
Parameter	Description
`id`	Device ID

Request Fields

Path Type Description

device_id

Number

The device id.

interface_name

String

The IoT interface on which to stop the Commissioner. The default is iot0.

HTTP Request

POST /devices/438086664193/thread/commissioner/:stop HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MCwiZXhwIjoxNzEyNzc4OTcwfQ.FbJbSLBWjWjJ6mw7Zupm7Xl4_VK0vjUuup983Hcgb8M
Content-Length: 50
Content-Type: application/json

{
  "device_id" : 1,
  "interface_name" : "iot0"
}

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/thread/commissioner/:stop' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MCwiZXhwIjoxNzEyNzc4OTcwfQ.FbJbSLBWjWjJ6mw7Zupm7Xl4_VK0vjUuup983Hcgb8M' \
    -H 'Content-Type: application/json' \
    -d '{
  "device_id" : 1,
  "interface_name" : "iot0"
}'

Get device WiFi interface stats

GET /devices/{id}/interfaces/wifi

Path parameters

Table 43. /devices/{id}/interfaces/wifi
Parameter	Description
`id`	Device ID

Request Parameters

Parameter Description

startTime

The start time for collecting the WiFi interface stats in ms

endTime

The end time for collecting the WiFi interface stats in ms

HTTP Request

GET /devices/438086664193/interfaces/wifi?startTime=1712087771118&endTime=1712174171118 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MSwiZXhwIjoxNzEyNzc4OTcxfQ.hpl3caNrvOJgrep7qQPPcsCt3T8H6dsqBT8ZbbDR884
Content-Type: application/json

Response Fields

Path Type Description

[].frequency

String

The WiFi frequency

[].ssid_count

Number

The number of SSID assigned on this wireless interface.

[].client_count

Number

The number of clients associated to this wireless interface.

[].neighbor_clients

Number

The number of neighboring clients.

[].channel_util

Number

The channel utilization.

[].channel

Number

The associated wireless channel

[].channel_width

Number

The channel width

[].tx_utilization

Number

The total tx utilization.

[].rx_utilization

Number

The total rx utilization.

[].tx_byte_count

Number

The total tx byte count

[].rx_byte_count

Number

The total rx byte count

[].noise_floor

Number

The noise floor

[].crc_error_frame

Number

The crc error frames

[].tx_retry_frame

Number

The tx retry frames

[].rx_retry_frame

Number

The tx retry frames

[].unicast_tx_packet_count

Number

The unicast tx packet count

[].unicast_rx_packet_count

Number

The unicast rx packet count

[].broadcast_tx_packet_count

Number

The broadcast tx packet count

[].broadcast_rx_packet_count

Number

The broadcast rx packet count

[].tx_air_time

Number

The total tx air time.

[].rx_air_time

Number

The total rx air time.

[].total_utilization

Number

The total utilization

[].scan_avg_interference

Number

The average scanned interference

[].mac_address

String

The BSSID

[].power

Number

The radio power

[].rx_errors

Number

The rx errors

[].tx_errors

Number

The tx errors

[].interface_name

String

The interface name

[].radio_profile_name

String

The ExtremecloudIQ radio profile name.

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Remaining: 7277
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Length: 1520
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

[ {
  "frequency" : "2.4G",
  "ssid_count" : 0,
  "client_count" : 0,
  "neighbor_clients" : 1,
  "channel_util" : 2,
  "channel" : 1,
  "channel_width" : 20,
  "tx_utilization" : 1,
  "rx_utilization" : 1,
  "tx_byte_count" : 100,
  "rx_byte_count" : 100,
  "noise_floor" : 0,
  "crc_error_frame" : 0,
  "tx_retry_frame" : 0,
  "rx_retry_frame" : 0,
  "unicast_tx_packet_count" : 100,
  "unicast_rx_packet_count" : 100,
  "broadcast_tx_packet_count" : 100,
  "broadcast_rx_packet_count" : 100,
  "tx_air_time" : 0,
  "rx_air_time" : 0,
  "total_utilization" : 0,
  "scan_avg_interference" : 1,
  "mac_address" : "AABBCCDDEEFF",
  "power" : 10,
  "rx_errors" : 0,
  "tx_errors" : 0,
  "interface_name" : "wifi0",
  "radio_profile_name" : "test-radio-profile"
}, {
  "frequency" : "5G",
  "ssid_count" : 0,
  "client_count" : 0,
  "neighbor_clients" : 1,
  "channel_util" : 2,
  "channel" : 1,
  "channel_width" : 20,
  "tx_utilization" : 1,
  "rx_utilization" : 1,
  "tx_byte_count" : 100,
  "rx_byte_count" : 100,
  "noise_floor" : 0,
  "crc_error_frame" : 0,
  "tx_retry_frame" : 0,
  "rx_retry_frame" : 0,
  "unicast_tx_packet_count" : 100,
  "unicast_rx_packet_count" : 100,
  "broadcast_tx_packet_count" : 100,
  "broadcast_rx_packet_count" : 100,
  "tx_air_time" : 0,
  "rx_air_time" : 0,
  "total_utilization" : 0,
  "scan_avg_interference" : 1,
  "mac_address" : "AABBCCDDEEFF",
  "power" : 10,
  "rx_errors" : 0,
  "tx_errors" : 0,
  "interface_name" : "wifi1",
  "radio_profile_name" : "test-radio-profile"
} ]

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/438086664193/interfaces/wifi?startTime=1712087771118&endTime=1712174171118' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MSwiZXhwIjoxNzEyNzc4OTcxfQ.hpl3caNrvOJgrep7qQPPcsCt3T8H6dsqBT8ZbbDR884' \
    -H 'Content-Type: application/json'

Get FTM settings by device ID

GET /devices/{id}/ftm-settings

Path Parameters

Table 44. /devices/{id}/ftm-settings
Parameter	Description
`id`	The device ID.

HTTP Request

GET /devices/438086664193/ftm-settings HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MiwiZXhwIjoxNzEyNzc4OTcyfQ.URqt4HYwGqzclYj0c-ukAAHQT-8kKAarYMcRn1skLwc
Host: api.extremecloudiq.com
Content-Type: application/json

Response Fields

Path Type Description

id

Number

The FTM settings ID.

create_time

String

The create time of the FTM settings.

update_time

String

The update time of the FTM settings.

wgs84_override

Boolean

World Geodetic System 1984 (WGS84) override: if 'false', GPS / AP-to-AP ranging / XIQ location values are used if available; if 'true', manual entries for latitude, longitude, and altitude are used.

wgs84

Object

World Geodetic System 1984 (WGS84) settings.

wgs84.latitude

Number

Degrees of latitude [-90.0 to 90.0]. Positive values indicate latitudes north of the equator, negative values indicate latitudes south of the equator.

wgs84.longitude

Number

Degrees of longitude [-180.0 to 180.0]. Measurements are relative to the zero meridian, with positive values extending east of the meridian and negative values extending west of the meridian.

wgs84.altitude

Number

Meters above sea level [-500.0 to 1000.0].

zsubelement_override

Boolean

Z-subelement override: if 'false', XIQ location values are used; if 'true', manual entries are used.

zsubelement

Object

Z-subelement settings.

zsubelement.expected_to_move

Boolean

Indicates whether the device is expected to move.

zsubelement.floor_number

Number

The floor number where the device is installed. Valid range: -25 to 250.

zsubelement.above_floor

Object

Above floor settings.

zsubelement.above_floor.height

Number

Height above the floor in meters. Valid range: 0.0 to 250.0 meters.

zsubelement.above_floor.height_uncertainty

Number

Height uncertainty in meters. Valid range: 0.0 to 10.0 meters.

civic_address_override

Boolean

Civic Address override: if 'false', XIQ location values are used; if 'true', the manual entry is used.

civic_address

String

Civic Address as hex encoded RFC4776 formatted string.

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: 566
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: 7263

{
  "id" : 1,
  "create_time" : "2024-04-03T19:56:12.000+0000",
  "update_time" : "2024-04-03T19:56:12.000+0000",
  "wgs84_override" : true,
  "wgs84" : {
    "latitude" : 43.8388393,
    "longitude" : -79.3814711,
    "altitude" : 201.0
  },
  "zsubelement_override" : true,
  "zsubelement" : {
    "expected_to_move" : false,
    "floor_number" : 1,
    "above_floor" : {
      "height" : 3.66,
      "height_uncertainty" : 0.2
    }
  },
  "civic_address_override" : true,
  "civic_address" : "000030434101074F6E746172696F030954686F726E68696C6C18064C3354375639"
}

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/438086664193/ftm-settings' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MiwiZXhwIjoxNzEyNzc4OTcyfQ.URqt4HYwGqzclYj0c-ukAAHQT-8kKAarYMcRn1skLwc' \
    -H 'Content-Type: application/json'

Configure FTM settings

PUT /devices/{id}/ftm-settings

Path Parameters

Table 45. /devices/{id}/ftm-settings
Parameter	Description
`id`	The device ID.

Request Fields

Path Type Description

wgs84_override

Boolean

World Geodetic System 1984 (WGS84) override: if 'false', GPS / AP-to-AP ranging / XIQ location values are used if available; if 'true', manual entries for latitude, longitude, and altitude are used.

wgs84

Object

World Geodetic System 1984 (WGS84) settings.

wgs84.latitude

Number

Degrees of latitude [-90.0 to 90.0]. Positive values indicate latitudes north of the equator, negative values indicate latitudes south of the equator.

wgs84.longitude

Number

Degrees of longitude [-180.0 to 180.0]. Measurements are relative to the zero meridian, with positive values extending east of the meridian and negative values extending west of the meridian.

wgs84.altitude

Number

Meters above sea level [-500.0 to 1000.0].

zsubelement_override

Boolean

Z-subelement override: if 'false', XIQ location values are used; if 'true', manual entries are used.

zsubelement

Object

Z-subelement settings.

zsubelement.expected_to_move

Boolean

Indicates whether the device is expected to move.

zsubelement.floor_number

Number

The floor number where the device is installed. Valid range: -25 to 250.

zsubelement.above_floor

Object

Above floor settings.

zsubelement.above_floor.height

Number

Height above the floor in meters. Valid range: 0.0 to 250.0 meters.

zsubelement.above_floor.height_uncertainty

Number

Height uncertainty in meters. Valid range: 0.0 to 10.0 meters.

civic_address_override

Boolean

Civic Address override: if 'false', XIQ location values are used; if 'true', the manual entry is used.

civic_address

String

Civic Address as hex encoded RFC4776 formatted string.

HTTP Request

PUT /devices/438086664193/ftm-settings HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MiwiZXhwIjoxNzEyNzc4OTcyfQ.URqt4HYwGqzclYj0c-ukAAHQT-8kKAarYMcRn1skLwc
Host: api.extremecloudiq.com
Content-Type: application/json
Content-Length: 454

{
  "wgs84_override" : true,
  "wgs84" : {
    "latitude" : 43.8388393,
    "longitude" : -79.3814711,
    "altitude" : 201.0
  },
  "zsubelement_override" : true,
  "zsubelement" : {
    "expected_to_move" : false,
    "floor_number" : 1,
    "above_floor" : {
      "height" : 3.66,
      "height_uncertainty" : 0.2
    }
  },
  "civic_address_override" : true,
  "civic_address" : "000030434101074F6E746172696F030954686F726E68696C6C18064C3354375639"
}

Response Fields

Path Type Description

id

Number

The FTM settings ID.

create_time

String

The create time of the FTM settings.

update_time

String

The update time of the FTM settings.

wgs84_override

Boolean

World Geodetic System 1984 (WGS84) override: if 'false', GPS / AP-to-AP ranging / XIQ location values are used if available; if 'true', manual entries for latitude, longitude, and altitude are used.

wgs84

Object

World Geodetic System 1984 (WGS84) settings.

wgs84.latitude

Number

Degrees of latitude [-90.0 to 90.0]. Positive values indicate latitudes north of the equator, negative values indicate latitudes south of the equator.

wgs84.longitude

Number

Degrees of longitude [-180.0 to 180.0]. Measurements are relative to the zero meridian, with positive values extending east of the meridian and negative values extending west of the meridian.

wgs84.altitude

Number

Meters above sea level [-500.0 to 1000.0].

zsubelement_override

Boolean

Z-subelement override: if 'false', XIQ location values are used; if 'true', manual entries are used.

zsubelement

Object

Z-subelement settings.

zsubelement.expected_to_move

Boolean

Indicates whether the device is expected to move.

zsubelement.floor_number

Number

The floor number where the device is installed. Valid range: -25 to 250.

zsubelement.above_floor

Object

Above floor settings.

zsubelement.above_floor.height

Number

Height above the floor in meters. Valid range: 0.0 to 250.0 meters.

zsubelement.above_floor.height_uncertainty

Number

Height uncertainty in meters. Valid range: 0.0 to 10.0 meters.

civic_address_override

Boolean

Civic Address override: if 'false', XIQ location values are used; if 'true', the manual entry is used.

civic_address

String

Civic Address as hex encoded RFC4776 formatted string.

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

{
  "id" : 1,
  "create_time" : "2024-04-03T19:56:12.000+0000",
  "update_time" : "2024-04-03T19:56:12.000+0000",
  "wgs84_override" : true,
  "wgs84" : {
    "latitude" : 43.8388393,
    "longitude" : -79.3814711,
    "altitude" : 201.0
  },
  "zsubelement_override" : true,
  "zsubelement" : {
    "expected_to_move" : false,
    "floor_number" : 1,
    "above_floor" : {
      "height" : 3.66,
      "height_uncertainty" : 0.2
    }
  },
  "civic_address_override" : true,
  "civic_address" : "000030434101074F6E746172696F030954686F726E68696C6C18064C3354375639"
}

cURL Request

$ curl 'https://api.extremecloudiq.com/devices/438086664193/ftm-settings' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MiwiZXhwIjoxNzEyNzc4OTcyfQ.URqt4HYwGqzclYj0c-ukAAHQT-8kKAarYMcRn1skLwc' \
    -H 'Content-Type: application/json' \
    -d '{
  "wgs84_override" : true,
  "wgs84" : {
    "latitude" : 43.8388393,
    "longitude" : -79.3814711,
    "altitude" : 201.0
  },
  "zsubelement_override" : true,
  "zsubelement" : {
    "expected_to_move" : false,
    "floor_number" : 1,
    "above_floor" : {
      "height" : 3.66,
      "height_uncertainty" : 0.2
    }
  },
  "civic_address_override" : true,
  "civic_address" : "000030434101074F6E746172696F030954686F726E68696C6C18064C3354375639"
}'

Delete FTM settings

DELETE /devices/{id}/ftm-settings

Path parameters

Table 46. /devices/{id}/ftm-settings
Parameter	Description
`id`	The device ID.

HTTP Request

DELETE /devices/438086664193/ftm-settings HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MiwiZXhwIjoxNzEyNzc4OTcyfQ.URqt4HYwGqzclYj0c-ukAAHQT-8kKAarYMcRn1skLwc
Host: api.extremecloudiq.com
Content-Type: application/json

HTTP Response

HTTP/1.1 200 OK
RateLimit-Remaining: 7264
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
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/ftm-settings' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MiwiZXhwIjoxNzEyNzc4OTcyfQ.URqt4HYwGqzclYj0c-ukAAHQT-8kKAarYMcRn1skLwc' \
    -H 'Content-Type: application/json'

Network Policy

List network policies

GET /network-policies

Request Parameters

Parameter Description

page

Page number

limit

Page size

fields

The network fields to return.
[All available fields]: id, create_time, update_time, org_id, owner_id, name description, type, predefined

keyword

The keyword to partial search by network policy name

policy_names

The list of policy names to filter

view

A view is a collection of network policy fields.
Currently supported views are basic and full.
[Basic View]: id, org_id, name, type
[Full View]:all fields

HTTP Request

GET /network-policies?page=1&limit=10&fields=NAME&fields=TYPE HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE4MCwiZXhwIjoxNzEyNzc4OTgwfQ.K3QgskRaKiBprF2Y2O9Kt48f6vub-aIU_svd_1rTevg
Host: api.extremecloudiq.com
Content-Type: application/json

Response Fields

Path Type Description

page

Number

The current page number.

count

Number

The element count of the current page.

total_pages

Number

The total page number based on request page size.

total_count

Number

The total element count.

data[].id

Number

The network policy ID.

data[].create_time

String

The timestamp when the network policy was created.

data[].update_time

String

The timestamp when the network policy was last updated.

data[].org_id

Number

The Organization ID.

data[].name

String

The network policy name.

data[].description

String

The network policy description.

data[].predefined

Boolean

Whether it is a predefined or not.

data[].type

String

The network policy type.

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Remaining: 7244
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Length: 666
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" : 2,
  "total_pages" : 1,
  "total_count" : 2,
  "data" : [ {
    "id" : 10,
    "create_time" : "2024-04-03T19:56:20.000+0000",
    "update_time" : "2024-04-03T19:56:20.000+0000",
    "org_id" : 0,
    "name" : "Policy_000",
    "description" : "Test network policy",
    "predefined" : false,
    "type" : "NETWORK_ACCESS_AND_BRANCH_ROUTING"
  }, {
    "id" : 11,
    "create_time" : "2024-04-03T19:56:20.000+0000",
    "update_time" : "2024-04-03T19:56:20.000+0000",
    "org_id" : 0,
    "name" : "Policy_001",
    "description" : "Test network policy",
    "predefined" : false,
    "type" : "NETWORK_ACCESS_AND_BRANCH_ROUTING"
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/network-policies?page=1&limit=10&fields=NAME&fields=TYPE' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE4MCwiZXhwIjoxNzEyNzc4OTgwfQ.K3QgskRaKiBprF2Y2O9Kt48f6vub-aIU_svd_1rTevg' \
    -H 'Content-Type: application/json'

Create network policy

POST /network-policies

Request Fields

Path Type Description

name

String

The network policy name

description

String

The network policy description

type

String

The network policy type

predefined

Boolean

Whether it is predefined

HTTP Request

POST /network-policies HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE4MCwiZXhwIjoxNzEyNzc4OTgwfQ.K3QgskRaKiBprF2Y2O9Kt48f6vub-aIU_svd_1rTevg
Host: api.extremecloudiq.com
Content-Length: 116
Content-Type: application/json

{
  "name" : "Policy_000",
  "description" : "Test network policy",
  "type" : "NETWORK_ACCESS_AND_BRANCH_ROUTING"
}

Response Fields

Path Type Description

id

Number

The network policy ID

create_time

String

The create time

update_time

String

The last update time

org_id

Number

The organization identifier, valid when enabling HIQ feature

name

String

The network policy name

description

String

The network policy description

type

String

The network policy type

predefined

Boolean

Whether it is predefined

HTTP Response

HTTP/1.1 201 Created
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
RateLimit-Remaining: 7247
X-Content-Type-Options: nosniff
Content-Length: 269
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" : 10,
  "create_time" : "2024-04-03T19:56:20.000+0000",
  "update_time" : "2024-04-03T19:56:20.000+0000",
  "org_id" : 0,
  "name" : "Policy_000",
  "description" : "Test network policy",
  "predefined" : false,
  "type" : "NETWORK_ACCESS_AND_BRANCH_ROUTING"
}

cURL Request

$ curl 'https://api.extremecloudiq.com/network-policies' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE4MCwiZXhwIjoxNzEyNzc4OTgwfQ.K3QgskRaKiBprF2Y2O9Kt48f6vub-aIU_svd_1rTevg' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "Policy_000",
  "description" : "Test network policy",
  "type" : "NETWORK_ACCESS_AND_BRANCH_ROUTING"
}'

Get network policy

GET /network-policies/{id}

Path parameters

Table 47. /network-policies/{id}
Parameter	Description
`id`	The network policy ID

HTTP Request

GET /network-policies/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE4MSwiZXhwIjoxNzEyNzc4OTgxfQ.764zU3FrIUrpSoZgyq3pLyouyWkc0vYfgOcbLi24lqU

Response Fields

Path Type Description

id

Number

The network policy ID

create_time

String

The create time

update_time

String

The last update time

org_id

Number

The organization identifier, valid when enabling HIQ feature

name

String

The network policy name

description

String

The network policy description

type

String

The network policy type

predefined

Boolean

Whether it is predefined

HTTP Response

HTTP/1.1 200 OK
RateLimit-Remaining: 7242
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Length: 269
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" : 10,
  "create_time" : "2024-04-03T19:56:21.000+0000",
  "update_time" : "2024-04-03T19:56:21.000+0000",
  "org_id" : 0,
  "name" : "Policy_000",
  "description" : "Test network policy",
  "predefined" : false,
  "type" : "NETWORK_ACCESS_AND_BRANCH_ROUTING"
}

cURL Request

$ curl 'https://api.extremecloudiq.com/network-policies/438086664193' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE4MSwiZXhwIjoxNzEyNzc4OTgxfQ.764zU3FrIUrpSoZgyq3pLyouyWkc0vYfgOcbLi24lqU'

Update network policy

PUT /network-policies/{id}

Path Parameters

Table 48. /network-policies/{id}
Parameter	Description
`id`	The network policy ID

Request Fields

Path Type Description

name

String

The network policy name

description

String

The network policy description

type

String

The network policy type

HTTP Request

PUT /network-policies/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE4MCwiZXhwIjoxNzEyNzc4OTgwfQ.K3QgskRaKiBprF2Y2O9Kt48f6vub-aIU_svd_1rTevg
Host: api.extremecloudiq.com
Content-Length: 116
Content-Type: application/json

{
  "name" : "Policy_000",
  "description" : "Test network policy",
  "type" : "NETWORK_ACCESS_AND_BRANCH_ROUTING"
}

Response Fields

Path Type Description

id

Number

The network policy ID

create_time

String

The create time

update_time

String

The last update time

org_id

Number

The organization identifier, valid when enabling HIQ feature

name

String

The network policy name

description

String

The network policy description

type

String

The network policy type

predefined

Boolean

Whether it is predefined

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
RateLimit-Remaining: 7246
Expires: 0
X-Content-Type-Options: nosniff
Content-Length: 269
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" : 10,
  "create_time" : "2024-04-03T19:56:20.000+0000",
  "update_time" : "2024-04-03T19:56:20.000+0000",
  "org_id" : 0,
  "name" : "Policy_000",
  "description" : "Test network policy",
  "predefined" : false,
  "type" : "NETWORK_ACCESS_AND_BRANCH_ROUTING"
}

cURL Request

$ curl 'https://api.extremecloudiq.com/network-policies/438086664193' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE4MCwiZXhwIjoxNzEyNzc4OTgwfQ.K3QgskRaKiBprF2Y2O9Kt48f6vub-aIU_svd_1rTevg' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "Policy_000",
  "description" : "Test network policy",
  "type" : "NETWORK_ACCESS_AND_BRANCH_ROUTING"
}'

Delete network policy

DELETE /network-policies/{id}

Path Parameters

Table 49. /network-policies/{id}
Parameter	Description
`id`	The network policy ID

HTTP Request

DELETE /network-policies/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE4MSwiZXhwIjoxNzEyNzc4OTgxfQ.764zU3FrIUrpSoZgyq3pLyouyWkc0vYfgOcbLi24lqU

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Remaining: 7244
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/network-policies/438086664193' -i -X DELETE \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE4MSwiZXhwIjoxNzEyNzc4OTgxfQ.764zU3FrIUrpSoZgyq3pLyouyWkc0vYfgOcbLi24lqU'

List SSIDs for network policy

GET /network-policies/{id}/ssids

Path Parameters

Table 50. /network-policies/{id}/ssids
Parameter	Description
`id`	The network policy ID.

Request Parameters

Parameter Description

page

Page number

limit

Page size

HTTP Request

GET /network-policies/438086664193/ssids?page=1&limit=10 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE4MCwiZXhwIjoxNzEyNzc4OTgwfQ.K3QgskRaKiBprF2Y2O9Kt48f6vub-aIU_svd_1rTevg
Host: api.extremecloudiq.com
Content-Type: application/json

Response Fields

Path Type Description

page

Number

The current page number.

count

Number

The element count of the current page.

total_pages

Number

The total page number based on request page size.

total_count

Number

The total element count.

data[].id

Number

The SSID ID.

data[].create_time

String

The timestamp when the network policy was created.

data[].update_time

String

The timestamp when the network policy was last updated.

data[].org_id

Number

The Organization ID.

data[].name

String

The SSID profile name.

data[].broadcast_name

String

The SSID broadcast name.

data[].description

String

The SSID description.

data[].predefined

Boolean

Whether it is predefined.

data[].advanced_settings_id

Number

The SSID advanced settings ID.

data[].attribute_key

Number

The SSID attribute key.

data[].access_security.key_value

String

The schedule type name.

data[].access_security.anti_logging_threshold

Number

The anti logging threshold value.

data[].access_security.transition_mode

Boolean

The flag for enabling transition mode.

data[].access_security.security_type

String

The security type.

data[].radius_client_profile.default_radius_client_object_id

Number

The default RADIUS client object ID.

data[].radius_client_profile.enable_classification

Boolean

The flag to enable classification entries on RADIUS client profile.

data[].radius_client_profile.classified_entries

Array

The RADIUS client profile classified entries.

data[].vendor_id

Number

The vendor id, when the Attribute type is CUSTOM.

data[].default_user_profile

Number

The default User Profile ID.

data[].user_profile_assignment_rules

Array

The SSID user profile assignment rules.

data[].enable_user_profile_assignment

Boolean

Flag for user profile assignment

data[].enable_radius_attribute_user_profile_assignment

Boolean

Flag for radius attribute UPA

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

{
  "page" : 1,
  "count" : 0,
  "total_pages" : 0,
  "total_count" : 0,
  "data" : [ {
    "id" : 10,
    "create_time" : "2024-04-03T19:56:20.000+0000",
    "update_time" : "2024-04-03T19:56:20.000+0000",
    "org_id" : 0,
    "name" : "SSID_000",
    "broadcast_name" : "SSID_000",
    "description" : "Test network policy",
    "predefined" : false,
    "advanced_settings_id" : 0,
    "enable_user_profile_assignment" : false,
    "enable_radius_attribute_user_profile_assignment" : false,
    "attribute_key" : 0,
    "access_security" : {
      "key_value" : "",
      "anti_logging_threshold" : 0,
      "transition_mode" : false,
      "security_type" : ""
    },
    "radius_client_profile" : {
      "default_radius_client_object_id" : 0,
      "enable_classification" : false,
      "classified_entries" : [ ]
    },
    "default_user_profile" : 0,
    "vendor_id" : 0,
    "user_profile_assignment_rules" : [ ]
  }, {
    "id" : 11,
    "create_time" : "2024-04-03T19:56:20.000+0000",
    "update_time" : "2024-04-03T19:56:20.000+0000",
    "org_id" : 0,
    "name" : "SSID_001",
    "broadcast_name" : "SSID_001",
    "description" : "Test network policy",
    "predefined" : false,
    "advanced_settings_id" : 0,
    "enable_user_profile_assignment" : false,
    "enable_radius_attribute_user_profile_assignment" : false,
    "attribute_key" : 0,
    "access_security" : {
      "key_value" : "",
      "anti_logging_threshold" : 0,
      "transition_mode" : false,
      "security_type" : ""
    },
    "radius_client_profile" : {
      "default_radius_client_object_id" : 0,
      "enable_classification" : false,
      "classified_entries" : [ ]
    },
    "default_user_profile" : 0,
    "vendor_id" : 0,
    "user_profile_assignment_rules" : [ ]
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/network-policies/438086664193/ssids?page=1&limit=10' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE4MCwiZXhwIjoxNzEyNzc4OTgwfQ.K3QgskRaKiBprF2Y2O9Kt48f6vub-aIU_svd_1rTevg' \
    -H 'Content-Type: application/json'

Add SSIDs to network policy

POST /network-policies/{id}/ssids/:add

Path Parameters

Table 51. /network-policies/{id}/ssids/:add
Parameter	Description
`id`	The network policy ID.

HTTP Request

POST /network-policies/438086664193/ssids/:add HTTP/1.1
Host: api.extremecloudiq.com
Content-Length: 44
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE4MSwiZXhwIjoxNzEyNzc4OTgxfQ.764zU3FrIUrpSoZgyq3pLyouyWkc0vYfgOcbLi24lqU

[ 438086664193, 438086664194, 438086664195 ]

HTTP Response

HTTP/1.1 200 OK
RateLimit-Remaining: 7243
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/network-policies/438086664193/ssids/:add' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE4MSwiZXhwIjoxNzEyNzc4OTgxfQ.764zU3FrIUrpSoZgyq3pLyouyWkc0vYfgOcbLi24lqU' \
    -d '[ 438086664193, 438086664194, 438086664195 ]'

Remove SSIDs from network policy

POST /network-policies/{id}/ssids/:remove

Path Parameters

Table 52. /network-policies/{id}/ssids/:remove
Parameter	Description
`id`	The network policy ID.

HTTP Request

POST /network-policies/438086664193/ssids/:remove HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE4MCwiZXhwIjoxNzEyNzc4OTgwfQ.K3QgskRaKiBprF2Y2O9Kt48f6vub-aIU_svd_1rTevg
Host: api.extremecloudiq.com
Content-Length: 44
Content-Type: application/json

[ 438086664193, 438086664194, 438086664195 ]

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
RateLimit-Remaining: 7245
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/network-policies/438086664193/ssids/:remove' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE4MCwiZXhwIjoxNzEyNzc4OTgwfQ.K3QgskRaKiBprF2Y2O9Kt48f6vub-aIU_svd_1rTevg' \
    -H 'Content-Type: application/json' \
    -d '[ 438086664193, 438086664194, 438086664195 ]'

Client

Get client details

GET /clients/{id}

Path parameters

Table 53. /clients/{id}
Parameter	Description
`id`	Client ID

Request Parameters

Parameter Description

views

A view is a collection of client fields.
Currently supported views are basic, detail, status, metrics, location, full.
[Basic View]: id, org_id, hostname, mac_address, ip_address, ipv6_address, os_type, device_id, connected, online_time, offline_time, connection_type, ssid, port.
[Detail View]: id, create_time, update_time, org_id, org_name, location_id, hostname, mac_address, ip_address, ipv6_address, os_type, device_id, device_function, device_name, device_mac_address, username, user_profile_name, connected, online_time, offline_time, vlan, connection_type, ssid, port, bssid, port_type_name, interface_name, auth, encryption_method, channel, rssi, snr, wing_ap, vendor, radio_type, alias.
[Status View]: id, connected, online_time, offline_time.
[Location View]: id, location_id, locations.
[Metrics View]: id, client_health, application_health, network_health, radio_health.
[Iot View]: id, mobility, category, description

fields

The client fields to return.
[All available fields]: id, create_time, update_time, org_id, org_name, location_id, hostname, mac_address, ip_address, ipv6_address, os_type, device_id, device_function, device_name, device_mac_address, username, user_profile_name, connected, online_time, offline_time, vlan, connection_type, ssid, port, bssid, port_type_name, interface_name, auth, encryption_method, channel, rssi, snr, wing_ap, vendor, mobility, category, description, locations, client_health, application_health, network_health, radio_health, radio_type, alias

HTTP Request

GET /clients/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MiwiZXhwIjoxNzEyNzc4OTcyfQ.URqt4HYwGqzclYj0c-ukAAHQT-8kKAarYMcRn1skLwc
Host: api.extremecloudiq.com
Content-Type: application/json

Response Fields

Path Type Description

id

Number

The client device ID.

create_time

String

The create time.

update_time

String

The last update time.

org_id

Number

The organization identifier, valid when enabling HIQ feature.

location_id

Number

The location identifier

device_id

Number

The associate device identifier

hostname

String

The hostname of the client

alias

String

The alias of the client

mac_address

String

The MAC address of the client

ip_address

String

The IP address of the client

ipv6_address

String

The IPv6 address of the client

os_type

String

The OS type of the client

username

String

The username of the client

user_profile_name

String

The user profile name of the client

connected

Boolean

Client is connected or not

online_time

String

The online time for the client

offline_time

String

The offline time for the client

vlan

Number

The associate VLAN

connection_type

Number

The connection type

ssid

String

The SSID

port

String

The associate device port

org_name

String

The organization name for the client

device_function

Number

The associate device function

device_mac_address

String

The associate device MAC address

device_name

String

The associate device name

auth

Number

The authenticate type of the client

channel

Number

The channel of the client

client_health

Number

The health score of the client

application_health

Number

The health score of the client application

radio_health

Number

The health score of the client radio

network_health

Number

The health score of client network

radio_type

Number

The radio type of the client

encryption_method

Number

The encryption method of the client

interface_name

String

The interface name of the client

bssid

String

The bssid of the client

rssi

Number

The rssi of the client

snr

Number

The snr of the client

location_id

Number

The location id of the client

description

String

The description of the client

category

String

The category of the client

mobility

String

The mobility of the client

port_type_name

String

The port type name of the client

wing_ap

Boolean

The client associated device is wing ap or not

vendor

String

The vendor of the client

locations[].id

Number

The location identifier

locations[].name

String

The unique name of location

HTTP Response

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

{
  "id" : 1,
  "create_time" : "2024-04-03T19:56:12.000+0000",
  "update_time" : "2024-04-03T19:56:12.000+0000",
  "org_id" : 0,
  "location_id" : 1,
  "device_id" : 1,
  "hostname" : "Hostname 2",
  "mac_address" : "5ELJP2LCLTZC",
  "ip_address" : "192.168.56.2",
  "ipv6_address" : "0000:0000:0000:0000:0000:0000:0000:0000 ",
  "os_type" : "Mac",
  "username" : "",
  "user_profile_name" : "",
  "connected" : true,
  "online_time" : "2024-04-03T19:56:12.000+0000",
  "offline_time" : "2024-04-03T19:56:12.000+0000",
  "vlan" : 1,
  "connection_type" : 0,
  "ssid" : "SSID 2",
  "port" : "22",
  "org_name" : "",
  "device_function" : 0,
  "device_mac_address" : "TVYGTCMRIIFQ",
  "device_name" : "test-device-2",
  "auth" : 0,
  "channel" : 0,
  "client_health" : 0,
  "application_health" : 0,
  "radio_health" : 0,
  "network_health" : 0,
  "radio_type" : 0,
  "encryption_method" : 0,
  "interface_name" : "",
  "bssid" : "",
  "rssi" : 0,
  "snr" : 0,
  "description" : "",
  "category" : "",
  "mobility" : "",
  "port_type_name" : "",
  "wing_ap" : false,
  "vendor" : "",
  "locations" : [ {
    "id" : 1,
    "name" : "test-location"
  } ],
  "alias" : "Alias 2"
}

cURL Request

$ curl 'https://api.extremecloudiq.com/clients/438086664193' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MiwiZXhwIjoxNzEyNzc4OTcyfQ.URqt4HYwGqzclYj0c-ukAAHQT-8kKAarYMcRn1skLwc' \
    -H 'Content-Type: application/json'

Get client details by mac

GET /clients/byMac/{clientMac}

Path parameters

Table 54. /clients/byMac/{clientMac}
Parameter	Description
`clientMac`	Mac address of the client.

Request Parameters

Parameter Description

views

fields

HTTP Request

GET /clients/byMac/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MiwiZXhwIjoxNzEyNzc4OTcyfQ.URqt4HYwGqzclYj0c-ukAAHQT-8kKAarYMcRn1skLwc
Host: api.extremecloudiq.com
Content-Type: application/json

Response Fields

Path Type Description

id

Number

The client device ID.

create_time

String

The create time.

update_time

String

The last update time.

org_id

Number

The organization identifier, valid when enabling HIQ feature.

location_id

Number

The location identifier

device_id

Number

The associate device identifier

hostname

String

The hostname of the client

alias

String

The alias of the client

mac_address

String

The MAC address of the client

ip_address

String

The IP address of the client

ipv6_address

String

The IPv6 address of the client

os_type

String

The OS type of the client

username

String

The username of the client

user_profile_name

String

The user profile name of the client

connected

Boolean

Client is connected or not

online_time

String

The online time for the client

offline_time

String

The offline time for the client

vlan

Number

The associate VLAN

connection_type

Number

The connection type

ssid

String

The SSID

port

String

The associate device port

org_name

String

The organization name for the client

device_function

Number

The associate device function

device_mac_address

String

The associate device MAC address

device_name

String

The associate device name

auth

Number

The authenticate type of the client

channel

Number

The channel of the client

client_health

Number

The health score of the client

application_health

Number

The health score of the client application

radio_health

Number

The health score of the client radio

network_health

Number

The health score of client network

radio_type

Number

The radio type of the client

encryption_method

Number

The encryption method of the client

interface_name

String

The interface name of the client

bssid

String

The bssid of the client

rssi

Number

The rssi of the client

snr

Number

The snr of the client

location_id

Number

The location id of the client

description

String

The description of the client

category

String

The category of the client

mobility

String

The mobility of the client

port_type_name

String

The port type name of the client

wing_ap

Boolean

The client associated device is wing ap or not

vendor

String

The vendor of the client

locations[].id

Number

The location identifier

locations[].name

String

The unique name of location

HTTP Response

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

{
  "id" : 1,
  "create_time" : "2024-04-03T19:56:12.000+0000",
  "update_time" : "2024-04-03T19:56:12.000+0000",
  "org_id" : 0,
  "location_id" : 1,
  "device_id" : 1,
  "hostname" : "Hostname 2",
  "mac_address" : "6GJW1DDUV0KL",
  "ip_address" : "192.168.56.2",
  "ipv6_address" : "0000:0000:0000:0000:0000:0000:0000:0000 ",
  "os_type" : "Mac",
  "username" : "",
  "user_profile_name" : "",
  "connected" : true,
  "online_time" : "2024-04-03T19:56:12.000+0000",
  "offline_time" : "2024-04-03T19:56:12.000+0000",
  "vlan" : 1,
  "connection_type" : 0,
  "ssid" : "SSID 2",
  "port" : "22",
  "org_name" : "",
  "device_function" : 0,
  "device_mac_address" : "KWLRWGSJXLCG",
  "device_name" : "test-device-2",
  "auth" : 0,
  "channel" : 0,
  "client_health" : 0,
  "application_health" : 0,
  "radio_health" : 0,
  "network_health" : 0,
  "radio_type" : 0,
  "encryption_method" : 0,
  "interface_name" : "",
  "bssid" : "",
  "rssi" : 0,
  "snr" : 0,
  "description" : "",
  "category" : "",
  "mobility" : "",
  "port_type_name" : "",
  "wing_ap" : false,
  "vendor" : "",
  "locations" : [ {
    "id" : 1,
    "name" : "test-location"
  } ],
  "alias" : "Alias 2"
}

cURL Request

$ curl 'https://api.extremecloudiq.com/clients/byMac/438086664193' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MiwiZXhwIjoxNzEyNzc4OTcyfQ.URqt4HYwGqzclYj0c-ukAAHQT-8kKAarYMcRn1skLwc' \
    -H 'Content-Type: application/json'

Get client list

GET /clients/active

Request Parameters

Parameter Description

locationIds

The location IDs

deviceIds

The device IDs

vlans

The associate VLAN IDs

userProfileNames

The user profile names

ssids

The SSIDs

clientOsNames

The client os names

clientConnectionTypes

The client connection types: 1 - WIRELESS, 2 - WIRED, -1 - UNDETERMINED

clientHealthStatus

The client health status: 1 - HEALTHY, 2 - POOR

excludeLocallyManaged

Return Cloud managed Devices' clients

userNames

The user names

searchString

The search string

page

Page number

limit

Page size

sortField

Sort field

sortOrder

Sort order (ascending by default)

views

fields

HTTP Request

GET /clients/active HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MiwiZXhwIjoxNzEyNzc4OTcyfQ.URqt4HYwGqzclYj0c-ukAAHQT-8kKAarYMcRn1skLwc
Host: api.extremecloudiq.com
Content-Type: application/json

Response Fields

Path Type Description

page

Number

The current page number.

count

Number

The element count of the current page.

total_pages

Number

The total page number based on request page size.

total_count

Number

The total element count.

data[].id

Number

The client device ID.

data[].create_time

String

The create time.

data[].update_time

String

The last update time.

data[].org_id

Number

The organization identifier, valid when enabling HIQ feature.

data[].location_id

Number

The location identifier

data[].device_id

Number

The associate device identifier

data[].hostname

String

The hostname of the client

data[].alias

String

The alias of the client

data[].mac_address

String

The MAC address of the client

data[].ip_address

String

The IP address of the client

data[].ipv6_address

String

The IPv6 address of the client

data[].os_type

String

The OS type of the client

data[].username

String

The username of the client

data[].user_profile_name

String

The user profile name of the client

data[].connected

Boolean

Client is connected or not

data[].online_time

String

The online time for the client

data[].offline_time

String

The offline time for the client

data[].vlan

Number

The associate VLAN

data[].connection_type

Number

The connection type

data[].ssid

String

The SSID

data[].port

String

The associate device port

data[].org_name

String

The organization name for the client

data[].device_function

Number

The associate device function

data[].device_mac_address

String

The associate device MAC address

data[].device_name

String

The associate device name

data[].auth

Number

The authenticate type of the client

data[].channel

Number

The channel of the client

data[].client_health

Number

The health score of the client

data[].application_health

Number

The health score of the client application

data[].radio_health

Number

The health score of the client radio

data[].network_health

Number

The health score of client network

data[].radio_type

Number

The radio type of the client

data[].encryption_method

Number

The encryption method of the client

data[].interface_name

String

The interface name of the client

data[].bssid

String

The bssid of the client

data[].rssi

Number

The rssi of the client

data[].snr

Number

The snr of the client

data[].location_id

Number

The location id of the client

data[].description

String

The description of the client

data[].category

String

The category of the client

data[].mobility

String

The mobility of the client

data[].port_type_name

String

The port type name of the client

data[].wing_ap

Boolean

The client associated device is wing ap or not

data[].vendor

String

The vendor of the client

data[].locations[].id

Number

The location identifier

data[].locations[].name

String

The unique name of location

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
RateLimit-Remaining: 7256
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: 12835

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 2,
  "total_count" : 15,
  "data" : [ {
    "id" : 0,
    "create_time" : "2024-04-03T19:56:12.000+0000",
    "update_time" : "2024-04-03T19:56:12.000+0000",
    "org_id" : 0,
    "location_id" : 1,
    "device_id" : 1,
    "hostname" : "Hostname 1",
    "mac_address" : "THOAOGUBQI04",
    "ip_address" : "192.168.56.1",
    "ipv6_address" : "0000:0000:0000:0000:0000:0000:0000:0000 ",
    "os_type" : "Mac",
    "username" : "",
    "user_profile_name" : "",
    "connected" : true,
    "online_time" : "2024-04-03T19:56:12.000+0000",
    "offline_time" : "2024-04-03T19:56:12.000+0000",
    "vlan" : 1,
    "connection_type" : 0,
    "ssid" : "SSID 1",
    "port" : "22",
    "org_name" : "",
    "device_function" : 0,
    "device_mac_address" : "NQO2AOOSK8MB",
    "device_name" : "test-device-1",
    "auth" : 0,
    "channel" : 0,
    "client_health" : 0,
    "application_health" : 0,
    "radio_health" : 0,
    "network_health" : 0,
    "radio_type" : 0,
    "encryption_method" : 0,
    "interface_name" : "",
    "bssid" : "",
    "rssi" : 0,
    "snr" : 0,
    "description" : "",
    "category" : "",
    "mobility" : "",
    "port_type_name" : "",
    "wing_ap" : false,
    "vendor" : "",
    "locations" : [ {
      "id" : 1,
      "name" : "test-location"
    } ],
    "alias" : "Alias 1"
  }, {
    "id" : 1,
    "create_time" : "2024-04-03T19:56:12.000+0000",
    "update_time" : "2024-04-03T19:56:12.000+0000",
    "org_id" : 0,
    "location_id" : 1,
    "device_id" : 1,
    "hostname" : "Hostname 2",
    "mac_address" : "XKIJCYGPNML6",
    "ip_address" : "192.168.56.2",
    "ipv6_address" : "0000:0000:0000:0000:0000:0000:0000:0000 ",
    "os_type" : "Mac",
    "username" : "",
    "user_profile_name" : "",
    "connected" : true,
    "online_time" : "2024-04-03T19:56:12.000+0000",
    "offline_time" : "2024-04-03T19:56:12.000+0000",
    "vlan" : 1,
    "connection_type" : 0,
    "ssid" : "SSID 2",
    "port" : "22",
    "org_name" : "",
    "device_function" : 0,
    "device_mac_address" : "ZQFLKUWFRUG1",
    "device_name" : "test-device-2",
    "auth" : 0,
    "channel" : 0,
    "client_health" : 0,
    "application_health" : 0,
    "radio_health" : 0,
    "network_health" : 0,
    "radio_type" : 0,
    "encryption_method" : 0,
    "interface_name" : "",
    "bssid" : "",
    "rssi" : 0,
    "snr" : 0,
    "description" : "",
    "category" : "",
    "mobility" : "",
    "port_type_name" : "",
    "wing_ap" : false,
    "vendor" : "",
    "locations" : [ {
      "id" : 1,
      "name" : "test-location"
    } ],
    "alias" : "Alias 2"
  }, {
    "id" : 2,
    "create_time" : "2024-04-03T19:56:12.000+0000",
    "update_time" : "2024-04-03T19:56:12.000+0000",
    "org_id" : 0,
    "location_id" : 1,
    "device_id" : 1,
    "hostname" : "Hostname 3",
    "mac_address" : "UG9AJOUOVAYX",
    "ip_address" : "192.168.56.3",
    "ipv6_address" : "0000:0000:0000:0000:0000:0000:0000:0000 ",
    "os_type" : "Mac",
    "username" : "",
    "user_profile_name" : "",
    "connected" : true,
    "online_time" : "2024-04-03T19:56:12.000+0000",
    "offline_time" : "2024-04-03T19:56:12.000+0000",
    "vlan" : 1,
    "connection_type" : 0,
    "ssid" : "SSID 3",
    "port" : "22",
    "org_name" : "",
    "device_function" : 0,
    "device_mac_address" : "7CKYNRZNMV9S",
    "device_name" : "test-device-3",
    "auth" : 0,
    "channel" : 0,
    "client_health" : 0,
    "application_health" : 0,
    "radio_health" : 0,
    "network_health" : 0,
    "radio_type" : 0,
    "encryption_method" : 0,
    "interface_name" : "",
    "bssid" : "",
    "rssi" : 0,
    "snr" : 0,
    "description" : "",
    "category" : "",
    "mobility" : "",
    "port_type_name" : "",
    "wing_ap" : false,
    "vendor" : "",
    "locations" : [ {
      "id" : 1,
      "name" : "test-location"
    } ],
    "alias" : "Alias 3"
  }, {
    "id" : 3,
    "create_time" : "2024-04-03T19:56:12.000+0000",
    "update_time" : "2024-04-03T19:56:12.000+0000",
    "org_id" : 0,
    "location_id" : 1,
    "device_id" : 1,
    "hostname" : "Hostname 4",
    "mac_address" : "ASWROTIXFN2Q",
    "ip_address" : "192.168.56.4",
    "ipv6_address" : "0000:0000:0000:0000:0000:0000:0000:0000 ",
    "os_type" : "Mac",
    "username" : "",
    "user_profile_name" : "",
    "connected" : true,
    "online_time" : "2024-04-03T19:56:12.000+0000",
    "offline_time" : "2024-04-03T19:56:12.000+0000",
    "vlan" : 1,
    "connection_type" : 0,
    "ssid" : "SSID 4",
    "port" : "22",
    "org_name" : "",
    "device_function" : 0,
    "device_mac_address" : "XMZKE71KYPHO",
    "device_name" : "test-device-4",
    "auth" : 0,
    "channel" : 0,
    "client_health" : 0,
    "application_health" : 0,
    "radio_health" : 0,
    "network_health" : 0,
    "radio_type" : 0,
    "encryption_method" : 0,
    "interface_name" : "",
    "bssid" : "",
    "rssi" : 0,
    "snr" : 0,
    "description" : "",
    "category" : "",
    "mobility" : "",
    "port_type_name" : "",
    "wing_ap" : false,
    "vendor" : "",
    "locations" : [ {
      "id" : 1,
      "name" : "test-location"
    } ],
    "alias" : "Alias 4"
  }, {
    "id" : 4,
    "create_time" : "2024-04-03T19:56:12.000+0000",
    "update_time" : "2024-04-03T19:56:12.000+0000",
    "org_id" : 0,
    "location_id" : 1,
    "device_id" : 1,
    "hostname" : "Hostname 5",
    "mac_address" : "Z8TDKA650MDX",
    "ip_address" : "192.168.56.5",
    "ipv6_address" : "0000:0000:0000:0000:0000:0000:0000:0000 ",
    "os_type" : "Mac",
    "username" : "",
    "user_profile_name" : "",
    "connected" : true,
    "online_time" : "2024-04-03T19:56:12.000+0000",
    "offline_time" : "2024-04-03T19:56:12.000+0000",
    "vlan" : 1,
    "connection_type" : 0,
    "ssid" : "SSID 5",
    "port" : "22",
    "org_name" : "",
    "device_function" : 0,
    "device_mac_address" : "MX1CPXY3ME84",
    "device_name" : "test-device-5",
    "auth" : 0,
    "channel" : 0,
    "client_health" : 0,
    "application_health" : 0,
    "radio_health" : 0,
    "network_health" : 0,
    "radio_type" : 0,
    "encryption_method" : 0,
    "interface_name" : "",
    "bssid" : "",
    "rssi" : 0,
    "snr" : 0,
    "description" : "",
    "category" : "",
    "mobility" : "",
    "port_type_name" : "",
    "wing_ap" : false,
    "vendor" : "",
    "locations" : [ {
      "id" : 1,
      "name" : "test-location"
    } ],
    "alias" : "Alias 5"
  }, {
    "id" : 5,
    "create_time" : "2024-04-03T19:56:12.000+0000",
    "update_time" : "2024-04-03T19:56:12.000+0000",
    "org_id" : 0,
    "location_id" : 1,
    "device_id" : 1,
    "hostname" : "Hostname 6",
    "mac_address" : "DNBKWWLPTEJQ",
    "ip_address" : "192.168.56.6",
    "ipv6_address" : "0000:0000:0000:0000:0000:0000:0000:0000 ",
    "os_type" : "Mac",
    "username" : "",
    "user_profile_name" : "",
    "connected" : true,
    "online_time" : "2024-04-03T19:56:12.000+0000",
    "offline_time" : "2024-04-03T19:56:12.000+0000",
    "vlan" : 1,
    "connection_type" : 0,
    "ssid" : "SSID 6",
    "port" : "22",
    "org_name" : "",
    "device_function" : 0,
    "device_mac_address" : "HF893CTZWMDQ",
    "device_name" : "test-device-6",
    "auth" : 0,
    "channel" : 0,
    "client_health" : 0,
    "application_health" : 0,
    "radio_health" : 0,
    "network_health" : 0,
    "radio_type" : 0,
    "encryption_method" : 0,
    "interface_name" : "",
    "bssid" : "",
    "rssi" : 0,
    "snr" : 0,
    "description" : "",
    "category" : "",
    "mobility" : "",
    "port_type_name" : "",
    "wing_ap" : false,
    "vendor" : "",
    "locations" : [ {
      "id" : 1,
      "name" : "test-location"
    } ],
    "alias" : "Alias 6"
  }, {
    "id" : 6,
    "create_time" : "2024-04-03T19:56:12.000+0000",
    "update_time" : "2024-04-03T19:56:12.000+0000",
    "org_id" : 0,
    "location_id" : 1,
    "device_id" : 1,
    "hostname" : "Hostname 7",
    "mac_address" : "YNIYYCZG95PW",
    "ip_address" : "192.168.56.7",
    "ipv6_address" : "0000:0000:0000:0000:0000:0000:0000:0000 ",
    "os_type" : "Mac",
    "username" : "",
    "user_profile_name" : "",
    "connected" : true,
    "online_time" : "2024-04-03T19:56:12.000+0000",
    "offline_time" : "2024-04-03T19:56:12.000+0000",
    "vlan" : 1,
    "connection_type" : 0,
    "ssid" : "SSID 7",
    "port" : "22",
    "org_name" : "",
    "device_function" : 0,
    "device_mac_address" : "EEWGHHOUSZUE",
    "device_name" : "test-device-7",
    "auth" : 0,
    "channel" : 0,
    "client_health" : 0,
    "application_health" : 0,
    "radio_health" : 0,
    "network_health" : 0,
    "radio_type" : 0,
    "encryption_method" : 0,
    "interface_name" : "",
    "bssid" : "",
    "rssi" : 0,
    "snr" : 0,
    "description" : "",
    "category" : "",
    "mobility" : "",
    "port_type_name" : "",
    "wing_ap" : false,
    "vendor" : "",
    "locations" : [ {
      "id" : 1,
      "name" : "test-location"
    } ],
    "alias" : "Alias 7"
  }, {
    "id" : 7,
    "create_time" : "2024-04-03T19:56:12.000+0000",
    "update_time" : "2024-04-03T19:56:12.000+0000",
    "org_id" : 0,
    "location_id" : 1,
    "device_id" : 1,
    "hostname" : "Hostname 8",
    "mac_address" : "MBNKNGXHDGQH",
    "ip_address" : "192.168.56.8",
    "ipv6_address" : "0000:0000:0000:0000:0000:0000:0000:0000 ",
    "os_type" : "Mac",
    "username" : "",
    "user_profile_name" : "",
    "connected" : true,
    "online_time" : "2024-04-03T19:56:12.000+0000",
    "offline_time" : "2024-04-03T19:56:12.000+0000",
    "vlan" : 1,
    "connection_type" : 0,
    "ssid" : "SSID 8",
    "port" : "22",
    "org_name" : "",
    "device_function" : 0,
    "device_mac_address" : "3BMJWQBY9KX2",
    "device_name" : "test-device-8",
    "auth" : 0,
    "channel" : 0,
    "client_health" : 0,
    "application_health" : 0,
    "radio_health" : 0,
    "network_health" : 0,
    "radio_type" : 0,
    "encryption_method" : 0,
    "interface_name" : "",
    "bssid" : "",
    "rssi" : 0,
    "snr" : 0,
    "description" : "",
    "category" : "",
    "mobility" : "",
    "port_type_name" : "",
    "wing_ap" : false,
    "vendor" : "",
    "locations" : [ {
      "id" : 1,
      "name" : "test-location"
    } ],
    "alias" : "Alias 8"
  }, {
    "id" : 8,
    "create_time" : "2024-04-03T19:56:12.000+0000",
    "update_time" : "2024-04-03T19:56:12.000+0000",
    "org_id" : 0,
    "location_id" : 1,
    "device_id" : 1,
    "hostname" : "Hostname 9",
    "mac_address" : "2EZKKHUYIMNG",
    "ip_address" : "192.168.56.9",
    "ipv6_address" : "0000:0000:0000:0000:0000:0000:0000:0000 ",
    "os_type" : "Mac",
    "username" : "",
    "user_profile_name" : "",
    "connected" : true,
    "online_time" : "2024-04-03T19:56:12.000+0000",
    "offline_time" : "2024-04-03T19:56:12.000+0000",
    "vlan" : 1,
    "connection_type" : 0,
    "ssid" : "SSID 9",
    "port" : "22",
    "org_name" : "",
    "device_function" : 0,
    "device_mac_address" : "DX8QSRTV9JZC",
    "device_name" : "test-device-9",
    "auth" : 0,
    "channel" : 0,
    "client_health" : 0,
    "application_health" : 0,
    "radio_health" : 0,
    "network_health" : 0,
    "radio_type" : 0,
    "encryption_method" : 0,
    "interface_name" : "",
    "bssid" : "",
    "rssi" : 0,
    "snr" : 0,
    "description" : "",
    "category" : "",
    "mobility" : "",
    "port_type_name" : "",
    "wing_ap" : false,
    "vendor" : "",
    "locations" : [ {
      "id" : 1,
      "name" : "test-location"
    } ],
    "alias" : "Alias 9"
  }, {
    "id" : 9,
    "create_time" : "2024-04-03T19:56:12.000+0000",
    "update_time" : "2024-04-03T19:56:12.000+0000",
    "org_id" : 0,
    "location_id" : 1,
    "device_id" : 1,
    "hostname" : "Hostname 10",
    "mac_address" : "LK68FY2QB8GS",
    "ip_address" : "192.168.56.10",
    "ipv6_address" : "0000:0000:0000:0000:0000:0000:0000:0000 ",
    "os_type" : "Mac",
    "username" : "",
    "user_profile_name" : "",
    "connected" : true,
    "online_time" : "2024-04-03T19:56:12.000+0000",
    "offline_time" : "2024-04-03T19:56:12.000+0000",
    "vlan" : 1,
    "connection_type" : 0,
    "ssid" : "SSID 10",
    "port" : "22",
    "org_name" : "",
    "device_function" : 0,
    "device_mac_address" : "RLRDGV4OTYF5",
    "device_name" : "test-device-10",
    "auth" : 0,
    "channel" : 0,
    "client_health" : 0,
    "application_health" : 0,
    "radio_health" : 0,
    "network_health" : 0,
    "radio_type" : 0,
    "encryption_method" : 0,
    "interface_name" : "",
    "bssid" : "",
    "rssi" : 0,
    "snr" : 0,
    "description" : "",
    "category" : "",
    "mobility" : "",
    "port_type_name" : "",
    "wing_ap" : false,
    "vendor" : "",
    "locations" : [ {
      "id" : 1,
      "name" : "test-location"
    } ],
    "alias" : "Alias 10"
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/clients/active' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MiwiZXhwIjoxNzEyNzc4OTcyfQ.URqt4HYwGqzclYj0c-ukAAHQT-8kKAarYMcRn1skLwc' \
    -H 'Content-Type: application/json'

Get client summary

GET /clients/summary

Request Parameters

Parameter Description

locationIds

The location IDss

deviceIds

The device IDs

vlans

The associate VLAN IDs

userProfileNames

The user profile names

ssids

The SSIDs

clientOsNames

The client os names

clientHealthStatus

The client health status: 1 - HEALTHY, 2 - POOR

excludeLocallyManaged

Return Cloud managed Devices' clients count

userNames

The user names

searchString

The search string

HTTP Request

GET /clients/summary?deviceIds=438086664193&vlans=1&userProfileNames=user1&locationIds=438086664193&ssids=Extreme&userNames=admin_cust HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MiwiZXhwIjoxNzEyNzc4OTcyfQ.URqt4HYwGqzclYj0c-ukAAHQT-8kKAarYMcRn1skLwc
Host: api.extremecloudiq.com
Content-Type: application/json

Response Fields

Path Type Description

connected_wireless_client_count

Number

The connected wireless clients count.

detected_wired_client_count

Number

The detected wired clients count.

connected_thread_client_count

Number

The connected thread clients count.

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
RateLimit-Remaining: 7256
X-XSS-Protection: 1; mode=block
Expires: 0
Content-Length: 119
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

{
  "connected_wireless_client_count" : 0,
  "detected_wired_client_count" : 0,
  "connected_thread_client_count" : 0
}

cURL Request

$ curl 'https://api.extremecloudiq.com/clients/summary?deviceIds=438086664193&vlans=1&userProfileNames=user1&locationIds=438086664193&ssids=Extreme&userNames=admin_cust' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MiwiZXhwIjoxNzEyNzc4OTcyfQ.URqt4HYwGqzclYj0c-ukAAHQT-8kKAarYMcRn1skLwc' \
    -H 'Content-Type: application/json'

Get client usage

GET /clients/usage

Request Parameters

Parameter Description

clientIds

The client IDs

startTime

The start time for querying client usage. unit: milliseconds

endTime

The end time for querying client usage. unit: milliseconds

HTTP Request

GET /clients/usage?clientIds=438086664193&clientIds=438086664194&startTime=1625038306000&endTime=1625038306001 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MiwiZXhwIjoxNzEyNzc4OTcyfQ.URqt4HYwGqzclYj0c-ukAAHQT-8kKAarYMcRn1skLwc
Host: api.extremecloudiq.com
Content-Type: application/json

Response Fields

Path Type Description

[].client_id

Number

The client identifier

[].usage

Number

The client usage over the specified period

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

[ {
  "client_id" : 1,
  "usage" : 10000
}, {
  "client_id" : 2,
  "usage" : 20000
}, {
  "client_id" : 3,
  "usage" : 30000
} ]

cURL Request

$ curl 'https://api.extremecloudiq.com/clients/usage?clientIds=438086664193&clientIds=438086664194&startTime=1625038306000&endTime=1625038306001' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MiwiZXhwIjoxNzEyNzc4OTcyfQ.URqt4HYwGqzclYj0c-ukAAHQT-8kKAarYMcRn1skLwc' \
    -H 'Content-Type: application/json'

Get count of active clients

GET /clients/active/count

Request Parameters

Parameter Description

locationIds

The location IDss

deviceIds

The device IDs

vlans

The associate VLAN IDs

userProfileNames

The user profile names

ssids

The SSIDs

clientOsNames

The client os names

clientConnectionTypes

The client connection types: 1 - WIRELESS, 2 - WIRED, -1 - UNDETERMINED

clientHealthStatus

The client health status: 1 - HEALTHY, 2 - POOR

excludeLocallyManaged

Return Cloud managed Devices' clients count

userNames

The user names

searchString

The search string

HTTP Request

GET /clients/active/count?deviceIds=438086664193&vlans=1&userProfileNames=user1&locationIds=438086664193&ssids=Extreme&userNames=admin_cust HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MiwiZXhwIjoxNzEyNzc4OTcyfQ.URqt4HYwGqzclYj0c-ukAAHQT-8kKAarYMcRn1skLwc
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
RateLimit-Remaining: 7258
X-Content-Type-Options: nosniff
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Content-Length: 1

1

cURL Request

$ curl 'https://api.extremecloudiq.com/clients/active/count?deviceIds=438086664193&vlans=1&userProfileNames=user1&locationIds=438086664193&ssids=Extreme&userNames=admin_cust' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MiwiZXhwIjoxNzEyNzc4OTcyfQ.URqt4HYwGqzclYj0c-ukAAHQT-8kKAarYMcRn1skLwc' \
    -H 'Content-Type: application/json'

Delete Client by macAddress

DELETE /clients/byMac/{clientMac}

Path Parameters

Table 55. /clients/byMac/{clientMac}
Parameter	Description
`clientMac`	Mac address of the client.

HTTP Request

DELETE /clients/byMac/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MiwiZXhwIjoxNzEyNzc4OTcyfQ.URqt4HYwGqzclYj0c-ukAAHQT-8kKAarYMcRn1skLwc
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: 7259
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/clients/byMac/438086664193' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MiwiZXhwIjoxNzEyNzc4OTcyfQ.URqt4HYwGqzclYj0c-ukAAHQT-8kKAarYMcRn1skLwc' \
    -H 'Content-Type: application/json'

Set aliases for multiple clients

PUT /clients/alias

Request Fields

Path Type Description

[].mac_address

String

The MAC address of the client

[].alias

String

The alias of the client

HTTP Request

PUT /clients/alias HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MiwiZXhwIjoxNzEyNzc4OTcyfQ.URqt4HYwGqzclYj0c-ukAAHQT-8kKAarYMcRn1skLwc
Host: api.extremecloudiq.com
Content-Type: application/json
Content-Length: 59

[ {
  "mac_address" : "acdc1234abba",
  "alias" : "bar"
} ]

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: 7261

cURL Request

$ curl 'https://api.extremecloudiq.com/clients/alias' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE3MiwiZXhwIjoxNzEyNzc4OTcyfQ.URqt4HYwGqzclYj0c-ukAAHQT-8kKAarYMcRn1skLwc' \
    -H 'Content-Type: application/json' \
    -d '[ {
  "mac_address" : "acdc1234abba",
  "alias" : "bar"
} ]'

Application

List applications

GET /applications

Request Parameters

Parameter Description

page

Page number

limit

Page size

applicationName

The application name

detectionProtocol

The application detection protocol

detectionType

The application detection type

predefined

Flag to filter predefined or customized application

sortField

The application sort filed

order

The application sort order

HTTP Request

GET /applications?page=1&limit=10&applicationName=1&predefined=false&sortField=NAME&order=ASC HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEzOSwiZXhwIjoxNzEyNzc4OTM5fQ.mcxTlf4oqFAI8Pyg69Cp6CQBrJEvHnWBHHbC5Rf0kLk
Host: api.extremecloudiq.com
Content-Type: application/json

Response Fields

Path Type Description

page

Number

The current page number

count

Number

The element count of the current page

total_pages

Number

The total page number based on request page size

total_count

Number

The total element count

data[].id

Number

The application ID

data[].create_time

String

The create time

data[].update_time

String

The last update time

data[].org_id

Number

The organization identifier, valid when enabling HIQ feature

data[].name

String

The application name

data[].description

String

The application description

data[].category_id

Number

The category ID of application

data[].category_name

String

The category name of application

data[].predefined

Boolean

Flag to describe whether the application is predefined or customized

data[].detection_rules[].type

String

The type of application detection rule

data[].detection_rules[].protocol

String

The protocol of application detection rule

data[].detection_rules[].value

String

The value of detection rule type

HTTP Response

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

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 1,
  "total_count" : 2,
  "data" : [ {
    "id" : 1,
    "create_time" : "2024-04-03T19:55:39.000+0000",
    "update_time" : "2024-04-03T19:55:39.000+0000",
    "org_id" : 0,
    "name" : "test-app-1",
    "description" : "test-app-desc-1",
    "predefined" : false,
    "category_id" : 1,
    "category_name" : "Networking",
    "detection_rules" : [ {
      "value" : "test.domain.com",
      "protocol" : "HTTPS",
      "type" : "HOST_NAME"
    }, {
      "value" : "test2.domain.com",
      "protocol" : "HTTPS",
      "type" : "SERVER_IP_ADDRESS"
    } ]
  }, {
    "id" : 2,
    "create_time" : "2024-04-03T19:55:39.000+0000",
    "update_time" : "2024-04-03T19:55:39.000+0000",
    "org_id" : 0,
    "name" : "test-app-2",
    "description" : "test-app-desc-2",
    "predefined" : false,
    "category_id" : 1,
    "category_name" : "Networking",
    "detection_rules" : [ {
      "value" : "test.domain.com",
      "protocol" : "HTTPS",
      "type" : "HOST_NAME"
    }, {
      "value" : "test2.domain.com",
      "protocol" : "HTTPS",
      "type" : "SERVER_IP_ADDRESS"
    } ]
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/applications?page=1&limit=10&applicationName=1&predefined=false&sortField=NAME&order=ASC' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEzOSwiZXhwIjoxNzEyNzc4OTM5fQ.mcxTlf4oqFAI8Pyg69Cp6CQBrJEvHnWBHHbC5Rf0kLk' \
    -H 'Content-Type: application/json'

List Top N clients usage for one application

GET /applications/{id}/clients/top{n}

Path parameters

Table 56. /applications/{id}/clients/top{n}
Parameter	Description
`id`	The Application ID
`n`	The TOP N number

HTTP Request

GET /applications/438086664193/clients/top10?startTime=1712087739719&endTime=1712174139719 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEzOSwiZXhwIjoxNzEyNzc4OTM5fQ.mcxTlf4oqFAI8Pyg69Cp6CQBrJEvHnWBHHbC5Rf0kLk
Host: api.extremecloudiq.com
Content-Type: application/json

Response Fields

Path Type Description

[].application_id

Number

The Application ID

[].client_id

Number

The TOP N Client ID

[].client_mac_address

String

The MAC address of TOP N Client

[].client_host_name

String

The host name of TOP N Client

[].usage

Number

The total usage of TOP N Client

HTTP Response

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

[ {
  "application_id" : 1,
  "client_id" : 1,
  "client_mac_address" : "AABBCCDDEE01",
  "client_host_name" : "test-client-1",
  "usage" : 100
}, {
  "application_id" : 1,
  "client_id" : 2,
  "client_mac_address" : "AABBCCDDEE02",
  "client_host_name" : "test-client-2",
  "usage" : 200
}, {
  "application_id" : 1,
  "client_id" : 3,
  "client_mac_address" : "AABBCCDDEE03",
  "client_host_name" : "test-client-3",
  "usage" : 300
} ]

cURL Request

$ curl 'https://api.extremecloudiq.com/applications/438086664193/clients/top10?startTime=1712087739719&endTime=1712174139719' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEzOSwiZXhwIjoxNzEyNzc4OTM5fQ.mcxTlf4oqFAI8Pyg69Cp6CQBrJEvHnWBHHbC5Rf0kLk' \
    -H 'Content-Type: application/json'

List Top N applications usage

GET /applications/top{n}

Path parameters

Table 57. /applications/top{n}
Parameter	Description
`n`	The TOP N number

HTTP Request

GET /applications/top10?startTime=1712087739900&endTime=1712174139900 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEzOSwiZXhwIjoxNzEyNzc4OTM5fQ.mcxTlf4oqFAI8Pyg69Cp6CQBrJEvHnWBHHbC5Rf0kLk
Host: api.extremecloudiq.com
Content-Type: application/json

Response Fields

Path Type Description

[].id

Number

The Application ID

[].name

String

The Application Name

[].clients

Number

The unique client count for current Application

[].users

Number

The unique user count for current Application

[].usage

Number

The total usage of Application

HTTP Response

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

[ {
  "id" : 1,
  "name" : "test-app-1",
  "clients" : 5,
  "users" : 10,
  "usage" : 1000
}, {
  "id" : 2,
  "name" : "test-app-2",
  "clients" : 10,
  "users" : 20,
  "usage" : 2000
} ]

cURL Request

$ curl 'https://api.extremecloudiq.com/applications/top10?startTime=1712087739900&endTime=1712174139900' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEzOSwiZXhwIjoxNzEyNzc4OTM5fQ.mcxTlf4oqFAI8Pyg69Cp6CQBrJEvHnWBHHbC5Rf0kLk' \
    -H 'Content-Type: application/json'

Alert

List the alerts

GET /alerts

Request Parameters

Parameter Description

page

Page number

limit

Page size

startTime

The start time for querying alerts

endTime

The end time for querying alerts

messageMetadataIds

The alert metadata to filter the query

severityIds

The alert severity identifiers to filter. The currently supported severity IDs are 1 for critical, 2 for warning, and 3 for info.

categoryIds

The category to filter the query

acknowledged

The alert acknowledge status

sortField

The sort field, such as source

order

The sort order, such as DESC

keyword

The keyword to filter, such as device SN or MAC address

HTTP Request

GET /alerts?page=1&limit=10&startTime=1712087742111&endTime=1712174142111&severityIds=998&severityIds=999&categoryIds=4877858&categoryIds=85865&messageMetadataIds=89868&messageMetadataIds=9383&acknowledged=true&sortField=SOURCE&order=DESC&keyword=BCF3105EA940 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MiwiZXhwIjoxNzEyNzc4OTQyfQ.QRaQvt4YzHvN2Vh819ewHmfcEfF5Bmpb2WZbV8PAdyM
Host: api.extremecloudiq.com
Content-Type: application/json

Response Fields

Path Type Description

page

Number

The current page number

count

Number

The element count of the current page

total_pages

Number

The total page number based on request page size

total_count

Number

The total element count

data[].id

String

The alert ID

data[].timestamp

String

The alert create time

data[].owner_id

Number

The owner ID

data[].org_id

Number

The organization identifier, valid when enabling HIQ feature

data[].message_metadata_id

Number

The alert metadata ID

data[].message_metadata_type

String

The alert metadata type

data[].summary

String

The alert summary

data[].severity_name

String

The alert severity Name

data[].severity_id

Number

The alert severity Id

data[].category_id

Number

The alert category ID

data[].category_name

String

The alert category name

data[].alert_rule_id

Number

The alert rule ID

data[].alert_policy_name

String

The alert policy name

data[].alert_policy_id

Number

The alert policy ID

data[].site_id

Number

The alert site ID

data[].site_name

String

The alert site name

data[].acknowledged

Boolean

The alert acknowledged status

data[].acknowledged_username

String

The acknowledged user name

data[].source.source_type_id

Number

The alert source type ID

data[].source.source_type_name

String

The alert source type name

data[].source.source_id

String

The alert source ID

data[].source.source_name

String

The alert source type

data[].tags[].id

Number

The unique identifier for the tag metadata

data[].tags[].name

String

The tag display name

data[].tags[].is_hidden

Boolean

If tag should be hidden from the user

data[].tags[].value

String

The tag value

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: 1254
X-Content-Type-Options: nosniff
RateLimit-Remaining: 7325
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 2,
  "total_count" : 15,
  "data" : [ {
    "id" : "100abc",
    "owner_id" : 101,
    "timestamp" : "2024-04-03T19:55:42.000+0000",
    "org_id" : 100,
    "message_metadata_id" : 738783,
    "message_metadata_type" : "",
    "summary" : "Device down",
    "severity_name" : "",
    "category_name" : "",
    "severity_id" : 7384884,
    "category_id" : 938833,
    "source" : {
      "source_type_id" : 0,
      "source_name" : "AP250",
      "source_type_name" : "HJRKJKJF",
      "source_id" : "100"
    },
    "tags" : [ {
      "id" : 7637373,
      "name" : "admin_state",
      "value" : "MANAGED",
      "is_hidden" : false
    }, {
      "id" : 76372332,
      "name" : "location_names",
      "value" : "Extreme -> San Jose -> floor1",
      "is_hidden" : false
    }, {
      "id" : 7632323,
      "name" : "product_type",
      "value" : "AP250",
      "is_hidden" : false
    }, {
      "id" : 7637232,
      "name" : "mac_address",
      "value" : "BCF3105EA940",
      "is_hidden" : true
    } ],
    "acknowledged" : false,
    "site_id" : 0,
    "site_name" : "",
    "alert_policy_id" : 0,
    "alert_policy_name" : "",
    "alert_rule_id" : 0,
    "acknowledged_username" : ""
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/alerts?page=1&limit=10&startTime=1712087742111&endTime=1712174142111&severityIds=998&severityIds=999&categoryIds=4877858&categoryIds=85865&messageMetadataIds=89868&messageMetadataIds=9383&acknowledged=true&sortField=SOURCE&order=DESC&keyword=BCF3105EA940' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MiwiZXhwIjoxNzEyNzc4OTQyfQ.QRaQvt4YzHvN2Vh819ewHmfcEfF5Bmpb2WZbV8PAdyM' \
    -H 'Content-Type: application/json'

Acknowledge the alerts

POST /alerts/:acknowledge

Request Fields

Path Type Description

alert_ids

Array

The alert ID list.

HTTP Request

POST /alerts/:acknowledge HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MiwiZXhwIjoxNzEyNzc4OTQyfQ.QRaQvt4YzHvN2Vh819ewHmfcEfF5Bmpb2WZbV8PAdyM
Host: api.extremecloudiq.com
Content-Type: application/json
Content-Length: 46

{
  "alert_ids" : [ "3232323", "43434u34u" ]
}

Response Fields

Path Type Description

[].id

String

The alert ID

[].timestamp

String

The alert create time

[].owner_id

Number

The owner ID

[].org_id

Number

The organization identifier, valid when enabling HIQ feature

[].message_metadata_id

Number

The alert metadata ID

[].message_metadata_type

String

The alert metadata type

[].summary

String

The alert summary

[].severity_name

String

The alert severity Name

[].severity_id

Number

The alert severity Id

[].category_id

Number

The alert category ID

[].category_name

String

The alert category name

[].alert_rule_id

Number

The alert rule ID

[].alert_policy_name

String

The alert policy name

[].alert_policy_id

Number

The alert policy ID

[].site_id

Number

The alert site ID

[].site_name

String

The alert site name

[].acknowledged

Boolean

The alert acknowledged status

[].acknowledged_username

String

The acknowledged user name

[].source.source_type_id

Number

The alert source type ID

[].source.source_type_name

String

The alert source type name

[].source.source_id

String

The alert source ID

[].source.source_name

String

The alert source type

[].tags[].id

Number

The unique identifier for the tag metadata

[].tags[].name

String

The tag display name

[].tags[].is_hidden

Boolean

If tag should be hidden from the user

[].tags[].value

String

The tag value

HTTP Response

HTTP/1.1 200 OK
Content-Length: 1074
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
RateLimit-Remaining: 7325
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" : "100abc",
  "owner_id" : 101,
  "timestamp" : "2024-04-03T19:55:42.000+0000",
  "org_id" : 100,
  "message_metadata_id" : 738783,
  "message_metadata_type" : "",
  "summary" : "Device down",
  "severity_name" : "",
  "category_name" : "",
  "severity_id" : 7384884,
  "category_id" : 938833,
  "source" : {
    "source_type_id" : 0,
    "source_name" : "AP250",
    "source_type_name" : "HJRKJKJF",
    "source_id" : "100"
  },
  "tags" : [ {
    "id" : 7637373,
    "name" : "admin_state",
    "value" : "MANAGED",
    "is_hidden" : false
  }, {
    "id" : 76372332,
    "name" : "location_names",
    "value" : "Extreme -> San Jose -> floor1",
    "is_hidden" : false
  }, {
    "id" : 7632323,
    "name" : "product_type",
    "value" : "AP250",
    "is_hidden" : false
  }, {
    "id" : 7637232,
    "name" : "mac_address",
    "value" : "BCF3105EA940",
    "is_hidden" : true
  } ],
  "acknowledged" : false,
  "site_id" : 0,
  "site_name" : "",
  "alert_policy_id" : 0,
  "alert_policy_name" : "",
  "alert_rule_id" : 0,
  "acknowledged_username" : ""
} ]

cURL Request

$ curl 'https://api.extremecloudiq.com/alerts/:acknowledge' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MiwiZXhwIjoxNzEyNzc4OTQyfQ.QRaQvt4YzHvN2Vh819ewHmfcEfF5Bmpb2WZbV8PAdyM' \
    -H 'Content-Type: application/json' \
    -d '{
  "alert_ids" : [ "3232323", "43434u34u" ]
}'

Count the alerts by group

GET /alerts/count-by-{group}

Path parameters

Table 58. /alerts/count-by-{group}
Parameter	Description
`group`	The group of the alert

HTTP Request

GET /alerts/count-by-SEVERITY?startTime=1712087741659&endTime=1712174141659&acknowledged=true&siteId=999 HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MSwiZXhwIjoxNzEyNzc4OTQxfQ.hFTCu4u0TkE-xhj7phOUCacxyvvnmG_r0Mn-SejHwA4

Response Fields

Path Type Description

[].group_id

Number

The group ID

[].group_name

String

The group name

[].count

Number

The count of group ID

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Remaining: 7332
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
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

[ {
  "group_id" : 39955,
  "group_name" : "Critical",
  "count" : 1
} ]

cURL Request

$ curl 'https://api.extremecloudiq.com/alerts/count-by-SEVERITY?startTime=1712087741659&endTime=1712174141659&acknowledged=true&siteId=999' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MSwiZXhwIjoxNzEyNzc4OTQxfQ.hFTCu4u0TkE-xhj7phOUCacxyvvnmG_r0Mn-SejHwA4'

List the alert policies

GET /alert-policies

Request Parameters

Parameter Description

policyType

The type of alert policy, such as SITE, GLOBAL

keyword

The keyword to filter, such as policy name or site name

HTTP Request

GET /alert-policies?policyType=SITE&keyword=yyeyey HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MCwiZXhwIjoxNzEyNzc4OTQwfQ.oRKNXPX2mtoxOkfG9QD7V5tJqbdVE1LbPo34GjK4Spk
Host: api.extremecloudiq.com
Content-Type: application/json

Response Fields

Path Type Description

global_policy.id

Number

The alert policy ID

global_policy.name

String

The name of alert policy

global_policy.owner_id

Number

The owner ID of alert policy

global_policy.org_id

Number

The Organization ID.

global_policy.sites[].site_id

Number

The site ID of this policy

global_policy.sites[].site_name

String

The site name of this policy

global_policy.event_rules_overview[].category_id

Number

The site list of this policy

global_policy.event_rules_overview[].category_name

String

The site list of this policy

global_policy.event_rules_overview[].rules[].id

Number

The unique identifier of this rule.

global_policy.event_rules_overview[].rules[].name

String

The human-readable name of this rule. Corresponds to the message_metadata_name from the get alert rule details API.

global_policy.event_rules_overview[].rules[].enabled

Boolean

Indicates whether this rule is in effect.

global_policy.metric_rules_overview[].metricset_id

Number

The unique identifier of the metricset.

global_policy.metric_rules_overview[].metricset_name

String

The human-readable name of the metricset.

global_policy.metric_rules_overview[].rules[].id

Number

The unique identifier of this rule.

global_policy.metric_rules_overview[].rules[].name

String

The human-readable name of this rule. Corresponds to the message_metadata_name from the get alert rule details API.

global_policy.metric_rules_overview[].rules[].enabled

Boolean

Indicates whether this rule is in effect.

site_policies[].id

Number

The alert policy ID

site_policies[].name

String

The name of alert policy

site_policies[].owner_id

Number

The owner ID of alert policy

site_policies[].org_id

Number

The Organization ID.

site_policies[].sites[].site_id

Number

The site ID of this policy

site_policies[].sites[].site_name

String

The site name of this policy

site_policies[].event_rules_overview[].category_id

Number

The site list of this policy

site_policies[].event_rules_overview[].category_name

String

The site list of this policy

site_policies[].event_rules_overview[].rules[].id

Number

The unique identifier of this rule.

site_policies[].event_rules_overview[].rules[].name

String

The human-readable name of this rule. Corresponds to the message_metadata_name from the get alert rule details API.

site_policies[].event_rules_overview[].rules[].enabled

Boolean

Indicates whether this rule is in effect.

site_policies[].metric_rules_overview[].metricset_id

Number

The unique identifier of the metricset.

site_policies[].metric_rules_overview[].metricset_name

String

The human-readable name of the metricset.

site_policies[].metric_rules_overview[].rules[].id

Number

The unique identifier of this rule.

site_policies[].metric_rules_overview[].rules[].name

String

The human-readable name of this rule. Corresponds to the message_metadata_name from the get alert rule details API.

site_policies[].metric_rules_overview[].rules[].enabled

Boolean

Indicates whether this rule is in effect.

HTTP Response

HTTP/1.1 200 OK
RateLimit-Remaining: 7342
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Length: 3852
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

{
  "global_policy" : {
    "id" : 7373773,
    "owner_id" : 101,
    "org_id" : 100,
    "name" : "Policy1",
    "sites" : [ {
      "site_id" : 8737743,
      "site_name" : "San Jose"
    }, {
      "site_id" : 8774774,
      "site_name" : "Edmonton AB"
    }, {
      "site_id" : 8734773,
      "site_name" : "Calgary AB"
    } ],
    "event_rules_overview" : [ {
      "category_id" : 7373773,
      "category_name" : "Category1",
      "rules" : [ {
        "id" : 8737737,
        "name" : "AlertRuleName",
        "enabled" : true
      }, {
        "id" : 8732424,
        "name" : "AlertRuleName3",
        "enabled" : true
      }, {
        "id" : 834343,
        "name" : "AlertRuleName3",
        "enabled" : true
      } ]
    }, {
      "category_id" : 737232,
      "category_name" : "Category2",
      "rules" : [ {
        "id" : 8737737,
        "name" : "AlertRuleName",
        "enabled" : true
      }, {
        "id" : 8732424,
        "name" : "AlertRuleName3",
        "enabled" : true
      }, {
        "id" : 834343,
        "name" : "AlertRuleName3",
        "enabled" : true
      } ]
    } ],
    "metric_rules_overview" : [ {
      "metricset_id" : 7373773,
      "metricset_name" : "Metricset1",
      "rules" : [ {
        "id" : 8737737,
        "name" : "AlertRuleName",
        "enabled" : true
      }, {
        "id" : 8732424,
        "name" : "AlertRuleName3",
        "enabled" : true
      }, {
        "id" : 834343,
        "name" : "AlertRuleName3",
        "enabled" : true
      } ]
    }, {
      "metricset_id" : 737232,
      "metricset_name" : "Metricset2",
      "rules" : [ {
        "id" : 8737737,
        "name" : "AlertRuleName",
        "enabled" : true
      }, {
        "id" : 8732424,
        "name" : "AlertRuleName3",
        "enabled" : true
      }, {
        "id" : 834343,
        "name" : "AlertRuleName3",
        "enabled" : true
      } ]
    } ]
  },
  "site_policies" : [ {
    "id" : 7373773,
    "owner_id" : 101,
    "org_id" : 100,
    "name" : "Policy1",
    "sites" : [ {
      "site_id" : 8737743,
      "site_name" : "San Jose"
    }, {
      "site_id" : 8774774,
      "site_name" : "Edmonton AB"
    }, {
      "site_id" : 8734773,
      "site_name" : "Calgary AB"
    } ],
    "event_rules_overview" : [ {
      "category_id" : 7373773,
      "category_name" : "Category1",
      "rules" : [ {
        "id" : 8737737,
        "name" : "AlertRuleName",
        "enabled" : true
      }, {
        "id" : 8732424,
        "name" : "AlertRuleName3",
        "enabled" : true
      }, {
        "id" : 834343,
        "name" : "AlertRuleName3",
        "enabled" : true
      } ]
    }, {
      "category_id" : 737232,
      "category_name" : "Category2",
      "rules" : [ {
        "id" : 8737737,
        "name" : "AlertRuleName",
        "enabled" : true
      }, {
        "id" : 8732424,
        "name" : "AlertRuleName3",
        "enabled" : true
      }, {
        "id" : 834343,
        "name" : "AlertRuleName3",
        "enabled" : true
      } ]
    } ],
    "metric_rules_overview" : [ {
      "metricset_id" : 7373773,
      "metricset_name" : "Metricset1",
      "rules" : [ {
        "id" : 8737737,
        "name" : "AlertRuleName",
        "enabled" : true
      }, {
        "id" : 8732424,
        "name" : "AlertRuleName3",
        "enabled" : true
      }, {
        "id" : 834343,
        "name" : "AlertRuleName3",
        "enabled" : true
      } ]
    }, {
      "metricset_id" : 737232,
      "metricset_name" : "Metricset2",
      "rules" : [ {
        "id" : 8737737,
        "name" : "AlertRuleName",
        "enabled" : true
      }, {
        "id" : 8732424,
        "name" : "AlertRuleName3",
        "enabled" : true
      }, {
        "id" : 834343,
        "name" : "AlertRuleName3",
        "enabled" : true
      } ]
    } ]
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/alert-policies?policyType=SITE&keyword=yyeyey' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MCwiZXhwIjoxNzEyNzc4OTQwfQ.oRKNXPX2mtoxOkfG9QD7V5tJqbdVE1LbPo34GjK4Spk' \
    -H 'Content-Type: application/json'

Get an alert policy

GET /alert-policies/{id}

Path Parameters

Table 59. /alert-policies/{id}
Parameter	Description
`id`	The ID of the alert policy

HTTP Request

GET /alert-policies/78437747 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MCwiZXhwIjoxNzEyNzc4OTQwfQ.oRKNXPX2mtoxOkfG9QD7V5tJqbdVE1LbPo34GjK4Spk
Host: api.extremecloudiq.com
Content-Type: application/json

Response Fields

Path Type Description

id

Number

The alert policy ID

name

String

The name of alert policy

owner_id

Number

The owner ID of alert policy

org_id

Number

The Organization ID.

sites[].site_id

Number

The site ID of this policy

sites[].site_name

String

The site name of this policy

event_rules_overview[].category_id

Number

The site list of this policy

event_rules_overview[].category_name

String

The site list of this policy

event_rules_overview[].rules[].id

Number

The unique identifier of this rule.

event_rules_overview[].rules[].name

String

The human-readable name of this rule. Corresponds to the message_metadata_name from the get alert rule details API.

event_rules_overview[].rules[].enabled

Boolean

Indicates whether this rule is in effect.

metric_rules_overview[].metricset_id

Number

The unique identifier of the metricset.

metric_rules_overview[].metricset_name

String

The human-readable name of the metricset.

metric_rules_overview[].rules[].id

Number

The unique identifier of this rule.

metric_rules_overview[].rules[].name

String

The human-readable name of this rule. Corresponds to the message_metadata_name from the get alert rule details API.

metric_rules_overview[].rules[].enabled

Boolean

Indicates whether this rule is in effect.

HTTP Response

HTTP/1.1 200 OK
Content-Length: 1739
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
RateLimit-Remaining: 7338
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" : 7373773,
  "owner_id" : 101,
  "org_id" : 100,
  "name" : "Policy1",
  "sites" : [ {
    "site_id" : 8737743,
    "site_name" : "San Jose"
  }, {
    "site_id" : 8774774,
    "site_name" : "Edmonton AB"
  }, {
    "site_id" : 8734773,
    "site_name" : "Calgary AB"
  } ],
  "event_rules_overview" : [ {
    "category_id" : 7373773,
    "category_name" : "Category1",
    "rules" : [ {
      "id" : 8737737,
      "name" : "AlertRuleName",
      "enabled" : true
    }, {
      "id" : 8732424,
      "name" : "AlertRuleName3",
      "enabled" : true
    }, {
      "id" : 834343,
      "name" : "AlertRuleName3",
      "enabled" : true
    } ]
  }, {
    "category_id" : 737232,
    "category_name" : "Category2",
    "rules" : [ {
      "id" : 8737737,
      "name" : "AlertRuleName",
      "enabled" : true
    }, {
      "id" : 8732424,
      "name" : "AlertRuleName3",
      "enabled" : true
    }, {
      "id" : 834343,
      "name" : "AlertRuleName3",
      "enabled" : true
    } ]
  } ],
  "metric_rules_overview" : [ {
    "metricset_id" : 7373773,
    "metricset_name" : "Metricset1",
    "rules" : [ {
      "id" : 8737737,
      "name" : "AlertRuleName",
      "enabled" : true
    }, {
      "id" : 8732424,
      "name" : "AlertRuleName3",
      "enabled" : true
    }, {
      "id" : 834343,
      "name" : "AlertRuleName3",
      "enabled" : true
    } ]
  }, {
    "metricset_id" : 737232,
    "metricset_name" : "Metricset2",
    "rules" : [ {
      "id" : 8737737,
      "name" : "AlertRuleName",
      "enabled" : true
    }, {
      "id" : 8732424,
      "name" : "AlertRuleName3",
      "enabled" : true
    }, {
      "id" : 834343,
      "name" : "AlertRuleName3",
      "enabled" : true
    } ]
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/alert-policies/78437747' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MCwiZXhwIjoxNzEyNzc4OTQwfQ.oRKNXPX2mtoxOkfG9QD7V5tJqbdVE1LbPo34GjK4Spk' \
    -H 'Content-Type: application/json'

Create an alert policy

POST /alert-policies

Request Parameters

Parameter Description

name

The policy name

siteIds

The site ID list.

HTTP Request

POST /alert-policies HTTP/1.1
Content-Length: 63
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MCwiZXhwIjoxNzEyNzc4OTQwfQ.oRKNXPX2mtoxOkfG9QD7V5tJqbdVE1LbPo34GjK4Spk
Host: api.extremecloudiq.com
Content-Type: application/json

{
  "name" : "Policy Name",
  "site_ids" : [ 3232323, 43434 ]
}

Response Fields

Path Type Description

id

Number

The alert policy ID

name

String

The name of alert policy

owner_id

Number

The owner ID of alert policy

org_id

Number

The Organization ID.

sites[].site_id

Number

The site ID of this policy

sites[].site_name

String

The site name of this policy

event_rules_overview[].category_id

Number

The site list of this policy

event_rules_overview[].category_name

String

The site list of this policy

event_rules_overview[].rules[].id

Number

The unique identifier of this rule.

event_rules_overview[].rules[].name

String

The human-readable name of this rule. Corresponds to the message_metadata_name from the get alert rule details API.

event_rules_overview[].rules[].enabled

Boolean

Indicates whether this rule is in effect.

metric_rules_overview[].metricset_id

Number

The unique identifier of the metricset.

metric_rules_overview[].metricset_name

String

The human-readable name of the metricset.

metric_rules_overview[].rules[].id

Number

The unique identifier of this rule.

metric_rules_overview[].rules[].name

String

The human-readable name of this rule. Corresponds to the message_metadata_name from the get alert rule details API.

metric_rules_overview[].rules[].enabled

Boolean

Indicates whether this rule is in effect.

HTTP Response

HTTP/1.1 200 OK
Content-Length: 1739
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: 7340

{
  "id" : 7373773,
  "owner_id" : 101,
  "org_id" : 100,
  "name" : "Policy1",
  "sites" : [ {
    "site_id" : 8737743,
    "site_name" : "San Jose"
  }, {
    "site_id" : 8774774,
    "site_name" : "Edmonton AB"
  }, {
    "site_id" : 8734773,
    "site_name" : "Calgary AB"
  } ],
  "event_rules_overview" : [ {
    "category_id" : 7373773,
    "category_name" : "Category1",
    "rules" : [ {
      "id" : 8737737,
      "name" : "AlertRuleName",
      "enabled" : true
    }, {
      "id" : 8732424,
      "name" : "AlertRuleName3",
      "enabled" : true
    }, {
      "id" : 834343,
      "name" : "AlertRuleName3",
      "enabled" : true
    } ]
  }, {
    "category_id" : 737232,
    "category_name" : "Category2",
    "rules" : [ {
      "id" : 8737737,
      "name" : "AlertRuleName",
      "enabled" : true
    }, {
      "id" : 8732424,
      "name" : "AlertRuleName3",
      "enabled" : true
    }, {
      "id" : 834343,
      "name" : "AlertRuleName3",
      "enabled" : true
    } ]
  } ],
  "metric_rules_overview" : [ {
    "metricset_id" : 7373773,
    "metricset_name" : "Metricset1",
    "rules" : [ {
      "id" : 8737737,
      "name" : "AlertRuleName",
      "enabled" : true
    }, {
      "id" : 8732424,
      "name" : "AlertRuleName3",
      "enabled" : true
    }, {
      "id" : 834343,
      "name" : "AlertRuleName3",
      "enabled" : true
    } ]
  }, {
    "metricset_id" : 737232,
    "metricset_name" : "Metricset2",
    "rules" : [ {
      "id" : 8737737,
      "name" : "AlertRuleName",
      "enabled" : true
    }, {
      "id" : 8732424,
      "name" : "AlertRuleName3",
      "enabled" : true
    }, {
      "id" : 834343,
      "name" : "AlertRuleName3",
      "enabled" : true
    } ]
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/alert-policies' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MCwiZXhwIjoxNzEyNzc4OTQwfQ.oRKNXPX2mtoxOkfG9QD7V5tJqbdVE1LbPo34GjK4Spk' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "Policy Name",
  "site_ids" : [ 3232323, 43434 ]
}'

Update an alert policy

PUT /alert-policies/{id}

Path Parameters

Table 60. /alert-policies/{id}
Parameter	Description
`id`	The ID of the alert policy

HTTP Request

PUT /alert-policies/78437747 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MCwiZXhwIjoxNzEyNzc4OTQwfQ.oRKNXPX2mtoxOkfG9QD7V5tJqbdVE1LbPo34GjK4Spk
Host: api.extremecloudiq.com
Content-Length: 62
Content-Type: application/json

{
  "name" : "PolicyName",
  "site_ids" : [ 3232323, 43434 ]
}

Response Fields

Path Type Description

id

Number

The alert policy ID

name

String

The name of alert policy

owner_id

Number

The owner ID of alert policy

org_id

Number

The Organization ID.

sites[].site_id

Number

The site ID of this policy

sites[].site_name

String

The site name of this policy

event_rules_overview[].category_id

Number

The site list of this policy

event_rules_overview[].category_name

String

The site list of this policy

event_rules_overview[].rules[].id

Number

The unique identifier of this rule.

event_rules_overview[].rules[].name

String

The human-readable name of this rule. Corresponds to the message_metadata_name from the get alert rule details API.

event_rules_overview[].rules[].enabled

Boolean

Indicates whether this rule is in effect.

metric_rules_overview[].metricset_id

Number

The unique identifier of the metricset.

metric_rules_overview[].metricset_name

String

The human-readable name of the metricset.

metric_rules_overview[].rules[].id

Number

The unique identifier of this rule.

metric_rules_overview[].rules[].name

String

The human-readable name of this rule. Corresponds to the message_metadata_name from the get alert rule details API.

metric_rules_overview[].rules[].enabled

Boolean

Indicates whether this rule is in effect.

HTTP Response

HTTP/1.1 200 OK
Content-Length: 1739
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
RateLimit-Remaining: 7344
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-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" : 7373773,
  "owner_id" : 101,
  "org_id" : 100,
  "name" : "Policy1",
  "sites" : [ {
    "site_id" : 8737743,
    "site_name" : "San Jose"
  }, {
    "site_id" : 8774774,
    "site_name" : "Edmonton AB"
  }, {
    "site_id" : 8734773,
    "site_name" : "Calgary AB"
  } ],
  "event_rules_overview" : [ {
    "category_id" : 7373773,
    "category_name" : "Category1",
    "rules" : [ {
      "id" : 8737737,
      "name" : "AlertRuleName",
      "enabled" : true
    }, {
      "id" : 8732424,
      "name" : "AlertRuleName3",
      "enabled" : true
    }, {
      "id" : 834343,
      "name" : "AlertRuleName3",
      "enabled" : true
    } ]
  }, {
    "category_id" : 737232,
    "category_name" : "Category2",
    "rules" : [ {
      "id" : 8737737,
      "name" : "AlertRuleName",
      "enabled" : true
    }, {
      "id" : 8732424,
      "name" : "AlertRuleName3",
      "enabled" : true
    }, {
      "id" : 834343,
      "name" : "AlertRuleName3",
      "enabled" : true
    } ]
  } ],
  "metric_rules_overview" : [ {
    "metricset_id" : 7373773,
    "metricset_name" : "Metricset1",
    "rules" : [ {
      "id" : 8737737,
      "name" : "AlertRuleName",
      "enabled" : true
    }, {
      "id" : 8732424,
      "name" : "AlertRuleName3",
      "enabled" : true
    }, {
      "id" : 834343,
      "name" : "AlertRuleName3",
      "enabled" : true
    } ]
  }, {
    "metricset_id" : 737232,
    "metricset_name" : "Metricset2",
    "rules" : [ {
      "id" : 8737737,
      "name" : "AlertRuleName",
      "enabled" : true
    }, {
      "id" : 8732424,
      "name" : "AlertRuleName3",
      "enabled" : true
    }, {
      "id" : 834343,
      "name" : "AlertRuleName3",
      "enabled" : true
    } ]
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/alert-policies/78437747' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MCwiZXhwIjoxNzEyNzc4OTQwfQ.oRKNXPX2mtoxOkfG9QD7V5tJqbdVE1LbPo34GjK4Spk' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "PolicyName",
  "site_ids" : [ 3232323, 43434 ]
}'

Delete an alert policy

DELETE /alert-policies/{id}

Path Parameters

Table 61. /alert-policies/{id}
Parameter	Description
`id`	The ID of the alert policy

HTTP Request

DELETE /alert-policies/78437747 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MCwiZXhwIjoxNzEyNzc4OTQwfQ.oRKNXPX2mtoxOkfG9QD7V5tJqbdVE1LbPo34GjK4Spk
Host: api.extremecloudiq.com
Content-Type: application/json

Response Body

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: 7340

cURL Request

$ curl 'https://api.extremecloudiq.com/alert-policies/78437747' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MCwiZXhwIjoxNzEyNzc4OTQwfQ.oRKNXPX2mtoxOkfG9QD7V5tJqbdVE1LbPo34GjK4Spk' \
    -H 'Content-Type: application/json'

Update an alert rule

PUT /alert-policies/{policyId}/rules/{ruleId}

Path Parameters

Table 62. /alert-policies/{policyId}/rules/{ruleId}
Parameter	Description
`policyId`	The ID of the alert policy
`ruleId`	The ID of the alert rule

HTTP Request

PUT /alert-policies/77875/rules/45998 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MCwiZXhwIjoxNzEyNzc4OTQwfQ.oRKNXPX2mtoxOkfG9QD7V5tJqbdVE1LbPo34GjK4Spk
Host: api.extremecloudiq.com
Content-Type: application/json
Content-Length: 147

{
  "description" : "Test Rule",
  "severity_id" : 1,
  "trigger_type" : "DEFERRED",
  "duration" : 300,
  "threshold" : 0.1,
  "operator" : "GE"
}

Response Fields

Path Type Description

id

Number

The unique identifier of this rule.

message_metadata_id

Number

The identifier for the unique message type that corresponds to this rule

message_metadata_name

String

The display name for the message

message_metadata_type

String

The type for the message

severity_name

String

Display name for this severity.Like Critical, Warning

threshold

Number

The threshold for the message. Has value when the alert type is "METRIC".

unit

String

The unit for threshold. Like %, bytes, etc

description

String

This is a description for the alert rule.

severity_id

Number

The severity identifier. The currently supported severity IDs are 1 for critical, 2 for warning, and 3 for info.

trigger_type

String

The configured trigger type of the rule. Options: IMMEDIATE, REPEATED and DEFERRED

is_enabled

Boolean

True if this rule is active and enabled

operator

String

The operator for the rule.Has value when the alert type is "METRIC".

duration

Number

The deferred duration in seconds. Has value when trigger_type is "DEFERRED"

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: 347
RateLimit-Remaining: 7339
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,
  "message_metadata_id" : 1,
  "message_metadata_name" : "DEVICE is up",
  "message_metadata_type" : "METRIC",
  "description" : "test alert Rule",
  "severity_id" : 1,
  "severity_name" : "Critical",
  "is_enabled" : true,
  "trigger_type" : "DEFERRED",
  "duration" : 600,
  "threshold" : 0.2,
  "unit" : "%",
  "operator" : "GT"
}

cURL Request

$ curl 'https://api.extremecloudiq.com/alert-policies/77875/rules/45998' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MCwiZXhwIjoxNzEyNzc4OTQwfQ.oRKNXPX2mtoxOkfG9QD7V5tJqbdVE1LbPo34GjK4Spk' \
    -H 'Content-Type: application/json' \
    -d '{
  "description" : "Test Rule",
  "severity_id" : 1,
  "trigger_type" : "DEFERRED",
  "duration" : 300,
  "threshold" : 0.1,
  "operator" : "GE"
}'

Get an alert rule

GET /alert-policies/{policyId}/rules/{ruleId}

Path Parameters

Table 63. /alert-policies/{policyId}/rules/{ruleId}
Parameter	Description
`policyId`	The ID of the alert policy
`ruleId`	The ID of the alert rule

HTTP Request

GET /alert-policies/77875/rules/45998 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MCwiZXhwIjoxNzEyNzc4OTQwfQ.oRKNXPX2mtoxOkfG9QD7V5tJqbdVE1LbPo34GjK4Spk
Host: api.extremecloudiq.com
Content-Type: application/json

Response Fields

Path Type Description

id

Number

The unique identifier of this rule.

message_metadata_id

Number

The identifier for the unique message type that corresponds to this rule

message_metadata_name

String

The display name for the message

message_metadata_type

String

The type for the message

severity_name

String

Display name for this severity.Like Critical, Warning

threshold

Number

The threshold for the message. Has value when the alert type is "METRIC".

unit

String

The unit for threshold. Like %, bytes, etc

description

String

This is a description for the alert rule.

severity_id

Number

The severity identifier. The currently supported severity IDs are 1 for critical, 2 for warning, and 3 for info.

trigger_type

String

The configured trigger type of the rule. Options: IMMEDIATE, REPEATED and DEFERRED

is_enabled

Boolean

True if this rule is active and enabled

operator

String

The operator for the rule.Has value when the alert type is "METRIC".

duration

Number

The deferred duration in seconds. Has value when trigger_type is "DEFERRED"

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Remaining: 7343
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Length: 347
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,
  "message_metadata_id" : 1,
  "message_metadata_name" : "DEVICE is up",
  "message_metadata_type" : "METRIC",
  "description" : "test alert Rule",
  "severity_id" : 1,
  "severity_name" : "Critical",
  "is_enabled" : true,
  "trigger_type" : "DEFERRED",
  "duration" : 600,
  "threshold" : 0.2,
  "unit" : "%",
  "operator" : "GT"
}

cURL Request

$ curl 'https://api.extremecloudiq.com/alert-policies/77875/rules/45998' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MCwiZXhwIjoxNzEyNzc4OTQwfQ.oRKNXPX2mtoxOkfG9QD7V5tJqbdVE1LbPo34GjK4Spk' \
    -H 'Content-Type: application/json'

Enable an alert rule

POST /alert-policies/{policyId}/rules/{ruleId}/:enable

Path Parameters

Table 64. /alert-policies/{policyId}/rules/{ruleId}/:enable
Parameter	Description
`policyId`	The ID of the alert policy
`ruleId`	The ID of the alert rule

HTTP Request

POST /alert-policies/77875/rules/45998/:enable HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MCwiZXhwIjoxNzEyNzc4OTQwfQ.oRKNXPX2mtoxOkfG9QD7V5tJqbdVE1LbPo34GjK4Spk
Host: api.extremecloudiq.com
Content-Type: application/json

Response Fields

Path Type Description

id

Number

The unique identifier of this rule.

message_metadata_id

Number

The identifier for the unique message type that corresponds to this rule

message_metadata_name

String

The display name for the message

message_metadata_type

String

The type for the message

severity_name

String

Display name for this severity.Like Critical, Warning

threshold

Number

The threshold for the message. Has value when the alert type is "METRIC".

unit

String

The unit for threshold. Like %, bytes, etc

description

String

This is a description for the alert rule.

severity_id

Number

The severity identifier. The currently supported severity IDs are 1 for critical, 2 for warning, and 3 for info.

trigger_type

String

The configured trigger type of the rule. Options: IMMEDIATE, REPEATED and DEFERRED

is_enabled

Boolean

True if this rule is active and enabled

operator

String

The operator for the rule.Has value when the alert type is "METRIC".

duration

Number

The deferred duration in seconds. Has value when trigger_type is "DEFERRED"

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
RateLimit-Remaining: 7346
X-Content-Type-Options: nosniff
Content-Length: 347
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,
  "message_metadata_id" : 1,
  "message_metadata_name" : "DEVICE is up",
  "message_metadata_type" : "METRIC",
  "description" : "test alert Rule",
  "severity_id" : 1,
  "severity_name" : "Critical",
  "is_enabled" : true,
  "trigger_type" : "DEFERRED",
  "duration" : 600,
  "threshold" : 0.2,
  "unit" : "%",
  "operator" : "GT"
}

cURL Request

$ curl 'https://api.extremecloudiq.com/alert-policies/77875/rules/45998/:enable' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MCwiZXhwIjoxNzEyNzc4OTQwfQ.oRKNXPX2mtoxOkfG9QD7V5tJqbdVE1LbPo34GjK4Spk' \
    -H 'Content-Type: application/json'

Disable an alert rule

POST /alert-policies/{policyId}/rules/{ruleId}/:disable

Path Parameters

Table 65. /alert-policies/{policyId}/rules/{ruleId}/:disable
Parameter	Description
`policyId`	The ID of the alert policy
`ruleId`	The ID of the alert rule

HTTP Request

POST /alert-policies/77875/rules/45998/:disable HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MCwiZXhwIjoxNzEyNzc4OTQwfQ.oRKNXPX2mtoxOkfG9QD7V5tJqbdVE1LbPo34GjK4Spk
Host: api.extremecloudiq.com
Content-Type: application/json

Response Fields

Path Type Description

id

Number

The unique identifier of this rule.

message_metadata_id

Number

The identifier for the unique message type that corresponds to this rule

message_metadata_name

String

The display name for the message

message_metadata_type

String

The type for the message

severity_name

String

Display name for this severity.Like Critical, Warning

threshold

Number

The threshold for the message. Has value when the alert type is "METRIC".

unit

String

The unit for threshold. Like %, bytes, etc

description

String

This is a description for the alert rule.

severity_id

Number

The severity identifier

trigger_type

String

The configured trigger type of the rule. Options: IMMEDIATE, REPEATED and DEFERRED

is_enabled

Boolean

True if this rule is active and enabled

operator

String

The operator for the rule.Has value when the alert type is "METRIC".

duration

Number

The deferred duration in seconds. Has value when trigger_type is "DEFERRED"

HTTP Response

HTTP/1.1 200 OK
RateLimit-Remaining: 7341
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Length: 348
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,
  "message_metadata_id" : 1,
  "message_metadata_name" : "DEVICE is up",
  "message_metadata_type" : "METRIC",
  "description" : "test alert Rule",
  "severity_id" : 1,
  "severity_name" : "Critical",
  "is_enabled" : false,
  "trigger_type" : "DEFERRED",
  "duration" : 600,
  "threshold" : 0.2,
  "unit" : "%",
  "operator" : "GT"
}

cURL Request

$ curl 'https://api.extremecloudiq.com/alert-policies/77875/rules/45998/:disable' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MCwiZXhwIjoxNzEyNzc4OTQwfQ.oRKNXPX2mtoxOkfG9QD7V5tJqbdVE1LbPo34GjK4Spk' \
    -H 'Content-Type: application/json'

List the available sites

GET /alert-policies/available-sites

Path Parameters

Table 66. /alert-policies/available-sites
Parameter	Description

HTTP Request

GET /alert-policies/available-sites HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MCwiZXhwIjoxNzEyNzc4OTQwfQ.oRKNXPX2mtoxOkfG9QD7V5tJqbdVE1LbPo34GjK4Spk
Host: api.extremecloudiq.com
Content-Type: application/json

Response Fields

Path Type Description

[].site_id

Number

The unique identifier of this site.

[].site_name

String

The site name.

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
Content-Length: 54
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
RateLimit-Remaining: 7345
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

[ {
  "site_id" : 7373773,
  "site_name" : "Site1"
} ]

cURL Request

$ curl 'https://api.extremecloudiq.com/alert-policies/available-sites' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MCwiZXhwIjoxNzEyNzc4OTQwfQ.oRKNXPX2mtoxOkfG9QD7V5tJqbdVE1LbPo34GjK4Spk' \
    -H 'Content-Type: application/json'

Create an alert report

POST /alerts/reports

Request Parameters

Parameter Description

startTime

The start time for querying alerts

endTime

The end time for querying alerts

messageMetadataIds

The alert metadata to filter the query

severityIds

The severity identifier. The currently supported severity IDs are 1 for critical, 2 for warning, and 3 for info.

timeZoneOffset

The category to filter the query

categoryIds

The category to filter the query

acknowledged

The alert acknowledge status

sortField

The sort field, such as source

order

The sort order, such as DESC

keyword

The keyword to filter, such as device SN or MAC address

async

Whether to query asynchronously

HTTP Request

POST /alerts/reports HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MSwiZXhwIjoxNzEyNzc4OTQxfQ.hFTCu4u0TkE-xhj7phOUCacxyvvnmG_r0Mn-SejHwA4

startTime=1712087741136&endTime=1712174141136&severityIds=998&severityIds=999&categoryIds=4877858&categoryIds=85865&messageMetadataIds=89868&messageMetadataIds=9383&acknowledged=true&sortField=SOURCE&order=DESC&keyword=BCF3105EA940&timeZoneOffset=1&async=true

Response Fields

Path Type Description

id

Number

The current page number

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
Content-Length: 20
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
RateLimit-Remaining: 7338
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" : 8734838
}

cURL Request

$ curl 'https://api.extremecloudiq.com/alerts/reports' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MSwiZXhwIjoxNzEyNzc4OTQxfQ.hFTCu4u0TkE-xhj7phOUCacxyvvnmG_r0Mn-SejHwA4' \
    -d 'startTime=1712087741136&endTime=1712174141136&severityIds=998&severityIds=999&categoryIds=4877858&categoryIds=85865&messageMetadataIds=89868&messageMetadataIds=9383&acknowledged=true&sortField=SOURCE&order=DESC&keyword=BCF3105EA940&timeZoneOffset=1&async=true'

Download an alert report

GET /alerts/reports/{id}

HTTP Request

GET /alerts/reports/8734838 HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MSwiZXhwIjoxNzEyNzc4OTQxfQ.hFTCu4u0TkE-xhj7phOUCacxyvvnmG_r0Mn-SejHwA4

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-Disposition: attachment; filename=8734838.csv
RateLimit-Remaining: 7337
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Content-Type: application/octet-stream
Content-Length: 124

/var/lib/jenkins/workspace/XIQ-RELEASE-BUILDS/RELEASE-24R3/xcloudiq-api/xcloudiq-api-gateway/target/test-classes/8734838.csv

cURL Request

$ curl 'https://api.extremecloudiq.com/alerts/reports/8734838' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MSwiZXhwIjoxNzEyNzc4OTQxfQ.hFTCu4u0TkE-xhj7phOUCacxyvvnmG_r0Mn-SejHwA4'

Path Parameter

Table 67. /alerts/reports/{id}
Parameter	Description
`id`	The report ID to download

Create an alert email subscription

POST /alert-subscriptions/emails

Request Fields

Path Type Description

email

String

The email address

is_subscribe_all

Boolean

The all alert policy selected flag

is_enabled

Boolean

Enable/disable alert notifications for an email

alert_policy_ids

Array

The selected alert policy list

HTTP Request

POST /alert-subscriptions/emails HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Content-Length: 111
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MSwiZXhwIjoxNzEyNzc4OTQxfQ.hFTCu4u0TkE-xhj7phOUCacxyvvnmG_r0Mn-SejHwA4

{
  "email" : "a@a.com",
  "is_enabled" : true,
  "is_subscribe_all" : false,
  "alert_policy_ids" : [ 1, 3 ]
}

Response Fields

Path Type Description

id

Number

The email ID

email

String

The email address

is_enabled

Boolean

Enable/disable alert notifications for an email

is_email_verified

Boolean

The email address verified flag

is_subscribe_all

Boolean

The all alert policy selected flag

alert_policy_ids

Array

The selected alert policy list

create_time

String

The create time

update_time

String

The last update time

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: 7335
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: 256

{
  "id" : 100,
  "create_time" : "2024-04-03T19:55:41.000+0000",
  "update_time" : "2024-04-03T19:55:41.000+0000",
  "email" : "a@a.com",
  "is_enabled" : true,
  "is_email_verified" : true,
  "is_subscribe_all" : false,
  "alert_policy_ids" : [ 83834 ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/alert-subscriptions/emails' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MSwiZXhwIjoxNzEyNzc4OTQxfQ.hFTCu4u0TkE-xhj7phOUCacxyvvnmG_r0Mn-SejHwA4' \
    -d '{
  "email" : "a@a.com",
  "is_enabled" : true,
  "is_subscribe_all" : false,
  "alert_policy_ids" : [ 1, 3 ]
}'

Delete an alert email subscription

DELETE /alert-subscriptions/emails/{id}

Path Parameters

Table 68. /alert-subscriptions/emails/{id}
Parameter	Description
`id`	The email ID

HTTP Request

DELETE /alert-subscriptions/emails/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MiwiZXhwIjoxNzEyNzc4OTQyfQ.QRaQvt4YzHvN2Vh819ewHmfcEfF5Bmpb2WZbV8PAdyM
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
RateLimit-Remaining: 7324
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/alert-subscriptions/emails/438086664193' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MiwiZXhwIjoxNzEyNzc4OTQyfQ.QRaQvt4YzHvN2Vh819ewHmfcEfF5Bmpb2WZbV8PAdyM' \
    -H 'Content-Type: application/json'

Bulk delete alert email subscriptions

POST /alert-subscriptions/emails/:delete

Request Fields

Path Type Description

ids

Array

The email IDs list.

HTTP Request

POST /alert-subscriptions/emails/:delete?async=false HTTP/1.1
Content-Length: 31
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MSwiZXhwIjoxNzEyNzc4OTQxfQ.hFTCu4u0TkE-xhj7phOUCacxyvvnmG_r0Mn-SejHwA4

{
  "ids" : [ 232323, 43434 ]
}

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: 7327
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: 26

{
  "result" : "SUCCESS"
}

cURL Request

$ curl 'https://api.extremecloudiq.com/alert-subscriptions/emails/:delete?async=false' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MSwiZXhwIjoxNzEyNzc4OTQxfQ.hFTCu4u0TkE-xhj7phOUCacxyvvnmG_r0Mn-SejHwA4' \
    -d '{
  "ids" : [ 232323, 43434 ]
}'

Get an alert email subscription

GET /alert-subscriptions/emails/{id}

Path parameters

Table 69. /alert-subscriptions/emails/{id}
Parameter	Description
`id`	The email ID

HTTP Request

GET /alert-subscriptions/emails/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MSwiZXhwIjoxNzEyNzc4OTQxfQ.hFTCu4u0TkE-xhj7phOUCacxyvvnmG_r0Mn-SejHwA4

Response Fields

Path Type Description

id

Number

The email ID

email

String

The email address

is_enabled

Boolean

Enable/disable alert notifications for an email

is_email_verified

Boolean

The email address verified flag

is_subscribe_all

Boolean

The all alert policy selected flag

alert_policy_ids

Array

The selected alert policy list

create_time

String

The create time

update_time

String

The last update time

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: 7328
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: 256

{
  "id" : 100,
  "create_time" : "2024-04-03T19:55:41.000+0000",
  "update_time" : "2024-04-03T19:55:41.000+0000",
  "email" : "a@a.com",
  "is_enabled" : true,
  "is_email_verified" : true,
  "is_subscribe_all" : false,
  "alert_policy_ids" : [ 83834 ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/alert-subscriptions/emails/438086664193' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MSwiZXhwIjoxNzEyNzc4OTQxfQ.hFTCu4u0TkE-xhj7phOUCacxyvvnmG_r0Mn-SejHwA4'

List alert email subscriptions

GET /alert-subscriptions/emails

Response Body

[ {
  "id" : 100,
  "create_time" : "2024-04-03T19:55:41.000+0000",
  "update_time" : "2024-04-03T19:55:41.000+0000",
  "email" : "a@a.com",
  "is_enabled" : true,
  "is_email_verified" : true,
  "is_subscribe_all" : false,
  "alert_policy_ids" : [ 1, 3 ]
} ]

HTTP Request

GET /alert-subscriptions/emails HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MSwiZXhwIjoxNzEyNzc4OTQxfQ.hFTCu4u0TkE-xhj7phOUCacxyvvnmG_r0Mn-SejHwA4

Response Fields

Path Type Description

[].id

Number

The email ID

[].email

String

The email address

[].is_enabled

Boolean

Enable/disable alert notifications for an email

[].is_email_verified

Boolean

The email address verified flag

[].is_subscribe_all

Boolean

The all alert policy selected flag

[].alert_policy_ids

Array

The selected alert policy list

[].create_time

String

The create time

[].update_time

String

The last update time

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: 7326
Content-Length: 259
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" : 100,
  "create_time" : "2024-04-03T19:55:41.000+0000",
  "update_time" : "2024-04-03T19:55:41.000+0000",
  "email" : "a@a.com",
  "is_enabled" : true,
  "is_email_verified" : true,
  "is_subscribe_all" : false,
  "alert_policy_ids" : [ 1, 3 ]
} ]

cURL Request

$ curl 'https://api.extremecloudiq.com/alert-subscriptions/emails' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MSwiZXhwIjoxNzEyNzc4OTQxfQ.hFTCu4u0TkE-xhj7phOUCacxyvvnmG_r0Mn-SejHwA4'

Update an alert email subscription

PUT /alert-subscriptions/emails/{id}

Path Parameters

Table 70. /alert-subscriptions/emails/{id}
Parameter	Description
`id`	The email ID

Request Fields

Path Type Description

email

String

The email address

is_subscribe_all

Boolean

The all alert policy selected flag

is_enabled

Boolean

Enable/disable alert notifications for an email

alert_policy_ids

Array

The selected alert policy list

HTTP Request

PUT /alert-subscriptions/emails/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Content-Length: 111
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MSwiZXhwIjoxNzEyNzc4OTQxfQ.hFTCu4u0TkE-xhj7phOUCacxyvvnmG_r0Mn-SejHwA4

{
  "email" : "a@a.com",
  "is_enabled" : true,
  "is_subscribe_all" : false,
  "alert_policy_ids" : [ 1, 3 ]
}

Response Fields

Path Type Description

id

Number

The email ID

email

String

The email address

is_enabled

Boolean

Enable/disable alert notifications for an email

is_email_verified

Boolean

The email address verified flag

is_subscribe_all

Boolean

The all alert policy selected flag

alert_policy_ids

Array

The selected alert policy list

create_time

String

The create time

update_time

String

The last update time

HTTP Response

HTTP/1.1 200 OK
RateLimit-Remaining: 7330
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: 256

{
  "id" : 100,
  "create_time" : "2024-04-03T19:55:41.000+0000",
  "update_time" : "2024-04-03T19:55:41.000+0000",
  "email" : "a@a.com",
  "is_enabled" : true,
  "is_email_verified" : true,
  "is_subscribe_all" : false,
  "alert_policy_ids" : [ 83834 ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/alert-subscriptions/emails/438086664193' -i -X PUT \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MSwiZXhwIjoxNzEyNzc4OTQxfQ.hFTCu4u0TkE-xhj7phOUCacxyvvnmG_r0Mn-SejHwA4' \
    -d '{
  "email" : "a@a.com",
  "is_enabled" : true,
  "is_subscribe_all" : false,
  "alert_policy_ids" : [ 1, 3 ]
}'

Verify an alert email subscription

POST /alert-subscriptions/emails/{id}/:verify

Path Parameters

Table 71. /alert-subscriptions/emails/{id}/:verify
Parameter	Description
`id`	The email ID

HTTP Request

POST /alert-subscriptions/emails/438086664193/:verify HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MSwiZXhwIjoxNzEyNzc4OTQxfQ.hFTCu4u0TkE-xhj7phOUCacxyvvnmG_r0Mn-SejHwA4

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: 7336
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/alert-subscriptions/emails/438086664193/:verify' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MSwiZXhwIjoxNzEyNzc4OTQxfQ.hFTCu4u0TkE-xhj7phOUCacxyvvnmG_r0Mn-SejHwA4'

Create an alert webhook subscription

POST /alert-subscriptions/webhooks

Request Fields

Path Type Description

url

String

The webhook endpoint URL

is_subscribe_all

Boolean

The all alert policy selected flag

secret

String

The auth secret for the webhook endpoint

is_enabled

Boolean

Enable/disable alert notifications for a webhook endpoint

alert_policy_ids

Array

The selected alert policy list

HTTP Request

POST /alert-subscriptions/webhooks HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Content-Length: 133
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MSwiZXhwIjoxNzEyNzc4OTQxfQ.hFTCu4u0TkE-xhj7phOUCacxyvvnmG_r0Mn-SejHwA4

{
  "url" : "https://a.com",
  "secret" : "a",
  "is_enabled" : true,
  "is_subscribe_all" : false,
  "alert_policy_ids" : [ 1, 3 ]
}

Response Fields

Path Type Description

id

Number

The webhook endpoint ID

url

String

The webhook endpoint URL

secret

String

The auth secret for the webhook endpoint

is_enabled

Boolean

Enable/disable alert notifications for a webhook endpoint

is_subscribe_all

Boolean

The all alert policy selected flag

alert_policy_ids

Array

The selected alert policy list

create_time

String

The create time

update_time

String

The last update time

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Remaining: 7332
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Length: 248
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" : 100,
  "create_time" : "2024-04-03T19:55:41.000+0000",
  "update_time" : "2024-04-03T19:55:41.000+0000",
  "url" : "https://a.com",
  "secret" : "a",
  "is_enabled" : true,
  "is_subscribe_all" : false,
  "alert_policy_ids" : [ 83834 ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/alert-subscriptions/webhooks' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MSwiZXhwIjoxNzEyNzc4OTQxfQ.hFTCu4u0TkE-xhj7phOUCacxyvvnmG_r0Mn-SejHwA4' \
    -d '{
  "url" : "https://a.com",
  "secret" : "a",
  "is_enabled" : true,
  "is_subscribe_all" : false,
  "alert_policy_ids" : [ 1, 3 ]
}'

Delete an alert webhook subscription

DELETE /alert-subscriptions/webhooks/{id}

Path Parameters

Table 72. /alert-subscriptions/webhooks/{id}
Parameter	Description
`id`	The webhook endpoint ID

HTTP Request

DELETE /alert-subscriptions/webhooks/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MSwiZXhwIjoxNzEyNzc4OTQxfQ.hFTCu4u0TkE-xhj7phOUCacxyvvnmG_r0Mn-SejHwA4

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
RateLimit-Remaining: 7333
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/alert-subscriptions/webhooks/438086664193' -i -X DELETE \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MSwiZXhwIjoxNzEyNzc4OTQxfQ.hFTCu4u0TkE-xhj7phOUCacxyvvnmG_r0Mn-SejHwA4'

Delete an alert webhook subscription

DELETE /alert-subscriptions/webhooks/{id}

Path Parameters

Table 73. /alert-subscriptions/webhooks/{id}
Parameter	Description
`id`	The webhook endpoint ID

HTTP Request

DELETE /alert-subscriptions/webhooks/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MSwiZXhwIjoxNzEyNzc4OTQxfQ.hFTCu4u0TkE-xhj7phOUCacxyvvnmG_r0Mn-SejHwA4

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
RateLimit-Remaining: 7333
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/alert-subscriptions/webhooks/438086664193' -i -X DELETE \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MSwiZXhwIjoxNzEyNzc4OTQxfQ.hFTCu4u0TkE-xhj7phOUCacxyvvnmG_r0Mn-SejHwA4'

Bulk delete alert webhook subscriptions

POST /alert-subscriptions/webhooks/:delete

Request Fields

Path Type Description

ids

Array

The subscription ID list.

HTTP Request

POST /alert-subscriptions/webhooks/:delete?async=false HTTP/1.1
Content-Length: 30
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MSwiZXhwIjoxNzEyNzc4OTQxfQ.hFTCu4u0TkE-xhj7phOUCacxyvvnmG_r0Mn-SejHwA4

{
  "ids" : [ 232323, 2223 ]
}

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
RateLimit-Remaining: 7334
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: 26

{
  "result" : "SUCCESS"
}

cURL Request

$ curl 'https://api.extremecloudiq.com/alert-subscriptions/webhooks/:delete?async=false' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MSwiZXhwIjoxNzEyNzc4OTQxfQ.hFTCu4u0TkE-xhj7phOUCacxyvvnmG_r0Mn-SejHwA4' \
    -d '{
  "ids" : [ 232323, 2223 ]
}'

Get an alert webhook subscription

GET /alert-subscriptions/webhooks/{id}

Path parameters

Table 74. /alert-subscriptions/webhooks/{id}
Parameter	Description
`id`	The webhook endpoint ID

HTTP Request

GET /alert-subscriptions/webhooks/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MSwiZXhwIjoxNzEyNzc4OTQxfQ.hFTCu4u0TkE-xhj7phOUCacxyvvnmG_r0Mn-SejHwA4

Response Fields

Path Type Description

id

Number

The webhook endpoint ID

url

String

The webhook endpoint URL

secret

String

The auth secret for the webhook endpoint

is_enabled

Boolean

Enable/disable alert notifications for a webhook endpoint

is_subscribe_all

Boolean

The all alert policy selected flag

alert_policy_ids

Array

The selected alert policy list

create_time

String

The create time

update_time

String

The last update time

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: 248
RateLimit-Remaining: 7329
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" : 100,
  "create_time" : "2024-04-03T19:55:41.000+0000",
  "update_time" : "2024-04-03T19:55:41.000+0000",
  "url" : "https://a.com",
  "secret" : "a",
  "is_enabled" : true,
  "is_subscribe_all" : false,
  "alert_policy_ids" : [ 83834 ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/alert-subscriptions/webhooks/438086664193' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MSwiZXhwIjoxNzEyNzc4OTQxfQ.hFTCu4u0TkE-xhj7phOUCacxyvvnmG_r0Mn-SejHwA4'

List the alert webhook subscriptions

GET /alert-subscriptions/webhooks

Response Body

[ {
  "id" : 100,
  "create_time" : "2024-04-03T19:55:42.000+0000",
  "update_time" : "2024-04-03T19:55:42.000+0000",
  "url" : "https://a.com",
  "secret" : "a",
  "is_enabled" : true,
  "is_subscribe_all" : false,
  "alert_policy_ids" : [ 1, 3 ]
} ]

HTTP Request

GET /alert-subscriptions/webhooks HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MiwiZXhwIjoxNzEyNzc4OTQyfQ.QRaQvt4YzHvN2Vh819ewHmfcEfF5Bmpb2WZbV8PAdyM
Host: api.extremecloudiq.com
Content-Type: application/json

Response Fields

Path Type Description

[].id

Number

The webhook endpoint ID

[].url

String

The webhook endpoint URL

[].secret

String

The auth secret for the webhook endpoint

[].is_enabled

Boolean

Enable/disable alert notifications for a webhook endpoint

[].is_subscribe_all

Boolean

The all alert policy selected flag

[].alert_policy_ids

Array

The selected alert policy list

[].create_time

String

The create time

[].update_time

String

The last update time

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
Content-Length: 251
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
RateLimit-Remaining: 7323
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" : 100,
  "create_time" : "2024-04-03T19:55:42.000+0000",
  "update_time" : "2024-04-03T19:55:42.000+0000",
  "url" : "https://a.com",
  "secret" : "a",
  "is_enabled" : true,
  "is_subscribe_all" : false,
  "alert_policy_ids" : [ 1, 3 ]
} ]

cURL Request

$ curl 'https://api.extremecloudiq.com/alert-subscriptions/webhooks' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MiwiZXhwIjoxNzEyNzc4OTQyfQ.QRaQvt4YzHvN2Vh819ewHmfcEfF5Bmpb2WZbV8PAdyM' \
    -H 'Content-Type: application/json'

Update an alert webhook subscription

PUT /alert-subscriptions/webhooks/{id}

Path Parameters

Table 75. /alert-subscriptions/webhooks/{id}
Parameter	Description
`id`	The webhook endpoint ID

Request Fields

Path Type Description

url

String

The webhook endpoint URL

is_subscribe_all

Boolean

The all alert policy selected flag

secret

String

The auth secret for the webhook endpoint

is_enabled

Boolean

Enable/disable alert notifications for a webhook endpoint

alert_policy_ids

Array

The selected alert policy list

HTTP Request

PUT /alert-subscriptions/webhooks/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Content-Length: 133
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MSwiZXhwIjoxNzEyNzc4OTQxfQ.hFTCu4u0TkE-xhj7phOUCacxyvvnmG_r0Mn-SejHwA4

{
  "url" : "https://a.com",
  "secret" : "a",
  "is_enabled" : true,
  "is_subscribe_all" : false,
  "alert_policy_ids" : [ 1, 3 ]
}

Response Fields

Path Type Description

id

Number

The webhook endpoint ID

url

String

The webhook endpoint URL

secret

String

The auth secret for the webhook endpoint

is_enabled

Boolean

Enable/disable alert notifications for a webhook endpoint

is_subscribe_all

Boolean

The all alert policy selected flag

alert_policy_ids

Array

The selected alert policy list

create_time

String

The create time

update_time

String

The last update time

HTTP Response

HTTP/1.1 200 OK
RateLimit-Remaining: 7331
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Length: 248
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" : 100,
  "create_time" : "2024-04-03T19:55:41.000+0000",
  "update_time" : "2024-04-03T19:55:41.000+0000",
  "url" : "https://a.com",
  "secret" : "a",
  "is_enabled" : true,
  "is_subscribe_all" : false,
  "alert_policy_ids" : [ 83834 ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/alert-subscriptions/webhooks/438086664193' -i -X PUT \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0MSwiZXhwIjoxNzEyNzc4OTQxfQ.hFTCu4u0TkE-xhj7phOUCacxyvvnmG_r0Mn-SejHwA4' \
    -d '{
  "url" : "https://a.com",
  "secret" : "a",
  "is_enabled" : true,
  "is_subscribe_all" : false,
  "alert_policy_ids" : [ 1, 3 ]
}'

Log

List accounting logs

GET /logs/accounting

Request Parameters

Parameter Description

page

Page number

limit

Page size

keyword

The keyword

startTime

start time

stopTime

stop time

HTTP Request

GET /logs/accounting?page=1&limit=10&keyword=&startTime=&stopTime=&keyword=&startTime=&stopTime= HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1NiwiZXhwIjoxNzEyNzc4OTU2fQ.YK2B_1n7Yejw1oxXU_Pf9sbqlhuedoNtWjoi3bX0QRA
Content-Type: application/json

Response Fields

Path Type Description

page

Number

The current page number.

count

Number

The element count of the current page.

total_pages

Number

The total page number based on request page size.

total_count

Number

The total element count.

data[].id

Number

The Email log ID.

data[].org_id

Number

The organization identifier, valid when enabling HIQ feature.

data[].username

String

The username.

data[].vhm_id

String

The vhm id.

data[].device_serial_number

String

The device serial number.

data[].acct_session_id

String

The accounting session id.

data[].acct_multi_id

String

The accounting multi id.

data[].group_name

String

The group name

data[].nas_ip_address

String

The nas ip address.

data[].nas_port

String

The nas port.

data[].nas_port_type

String

The nas port type.

data[].acct_start_time

Number

The acct start time.

data[].acct_stop_time

Number

The acct stop time.

data[].acct_session_time

Number

The acct session time.

data[].acct_authentic

String

The acct authentic.

data[].connect_info

String

The connect info.

data[].acct_input_octets

Number

The acct input octets.

data[].acct_output_octets

Number

The acct output octets.

data[].called_station_id

String

The called station id.

data[].calling_station_id

String

The calling station id.

data[].acct_terminate_cause

String

The acct terminate cause.

data[].service_type

String

The service type.

data[].framed_ip_address

String

The framed ip address.

data[].acct_start_delay

Number

The acct start delay.

data[].acct_stop_delay

Number

The acct stop delay.

data[].ssid

String

The ssid.

data[].identity

String

The identity.

data[].nas_identifier

String

The nas identifier.

data[].mgmt_mac_address

String

The mgmt mac address.

data[].attribute_num

Number

The attribute num.

data[].event_time

Number

The event time.

data[].timestamp

Number

The email log timestamp.

data[].usage

Number

The usage.

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: 9051
X-Content-Type-Options: nosniff
RateLimit-Remaining: 7329
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 2,
  "total_count" : 15,
  "data" : [ {
    "id" : 1,
    "username" : "user0",
    "org_id" : 10,
    "timestamp" : 1615279279996,
    "vhm_id" : "vhm_0",
    "device_serial_number" : "123123123",
    "acct_session_id" : "0",
    "acct_multi_id" : "0",
    "group_name" : "group_0",
    "nas_ip_address" : "0",
    "nas_port" : "0",
    "nas_port_type" : "0",
    "acct_start_time" : 0,
    "acct_stop_time" : 0,
    "acct_session_time" : 0,
    "acct_authentic" : "0",
    "connect_info" : "0",
    "acct_input_octets" : 0,
    "acct_output_octets" : 0,
    "called_station_id" : "0",
    "calling_station_id" : "0",
    "acct_terminate_cause" : "0",
    "service_type" : "0",
    "framed_ip_address" : "0",
    "acct_start_delay" : 0,
    "acct_stop_delay" : 0,
    "ssid" : "0",
    "identity" : "0",
    "nas_identifier" : "0",
    "mgmt_mac_address" : "0",
    "attribute_num" : 0,
    "event_time" : 0,
    "usage" : 1000
  }, {
    "id" : 2,
    "username" : "user1",
    "org_id" : 10,
    "timestamp" : 1615279279996,
    "vhm_id" : "vhm_1",
    "device_serial_number" : "123123123",
    "acct_session_id" : "1",
    "acct_multi_id" : "1",
    "group_name" : "group_1",
    "nas_ip_address" : "1",
    "nas_port" : "1",
    "nas_port_type" : "1",
    "acct_start_time" : 1,
    "acct_stop_time" : 1,
    "acct_session_time" : 1,
    "acct_authentic" : "1",
    "connect_info" : "1",
    "acct_input_octets" : 1,
    "acct_output_octets" : 1,
    "called_station_id" : "1",
    "calling_station_id" : "1",
    "acct_terminate_cause" : "1",
    "service_type" : "1",
    "framed_ip_address" : "1",
    "acct_start_delay" : 0,
    "acct_stop_delay" : 0,
    "ssid" : "1",
    "identity" : "1",
    "nas_identifier" : "1",
    "mgmt_mac_address" : "1",
    "attribute_num" : 1,
    "event_time" : 1,
    "usage" : 1000
  }, {
    "id" : 3,
    "username" : "user2",
    "org_id" : 10,
    "timestamp" : 1615279279996,
    "vhm_id" : "vhm_2",
    "device_serial_number" : "123123123",
    "acct_session_id" : "2",
    "acct_multi_id" : "2",
    "group_name" : "group_2",
    "nas_ip_address" : "2",
    "nas_port" : "2",
    "nas_port_type" : "2",
    "acct_start_time" : 2,
    "acct_stop_time" : 2,
    "acct_session_time" : 2,
    "acct_authentic" : "2",
    "connect_info" : "2",
    "acct_input_octets" : 2,
    "acct_output_octets" : 2,
    "called_station_id" : "2",
    "calling_station_id" : "2",
    "acct_terminate_cause" : "2",
    "service_type" : "2",
    "framed_ip_address" : "2",
    "acct_start_delay" : 0,
    "acct_stop_delay" : 0,
    "ssid" : "2",
    "identity" : "2",
    "nas_identifier" : "2",
    "mgmt_mac_address" : "2",
    "attribute_num" : 2,
    "event_time" : 2,
    "usage" : 1000
  }, {
    "id" : 4,
    "username" : "user3",
    "org_id" : 10,
    "timestamp" : 1615279279996,
    "vhm_id" : "vhm_3",
    "device_serial_number" : "123123123",
    "acct_session_id" : "3",
    "acct_multi_id" : "3",
    "group_name" : "group_3",
    "nas_ip_address" : "3",
    "nas_port" : "3",
    "nas_port_type" : "3",
    "acct_start_time" : 3,
    "acct_stop_time" : 3,
    "acct_session_time" : 3,
    "acct_authentic" : "3",
    "connect_info" : "3",
    "acct_input_octets" : 3,
    "acct_output_octets" : 3,
    "called_station_id" : "3",
    "calling_station_id" : "3",
    "acct_terminate_cause" : "3",
    "service_type" : "3",
    "framed_ip_address" : "3",
    "acct_start_delay" : 0,
    "acct_stop_delay" : 0,
    "ssid" : "3",
    "identity" : "3",
    "nas_identifier" : "3",
    "mgmt_mac_address" : "3",
    "attribute_num" : 3,
    "event_time" : 3,
    "usage" : 1000
  }, {
    "id" : 5,
    "username" : "user4",
    "org_id" : 10,
    "timestamp" : 1615279279996,
    "vhm_id" : "vhm_4",
    "device_serial_number" : "123123123",
    "acct_session_id" : "4",
    "acct_multi_id" : "4",
    "group_name" : "group_4",
    "nas_ip_address" : "4",
    "nas_port" : "4",
    "nas_port_type" : "4",
    "acct_start_time" : 4,
    "acct_stop_time" : 4,
    "acct_session_time" : 4,
    "acct_authentic" : "4",
    "connect_info" : "4",
    "acct_input_octets" : 4,
    "acct_output_octets" : 4,
    "called_station_id" : "4",
    "calling_station_id" : "4",
    "acct_terminate_cause" : "4",
    "service_type" : "4",
    "framed_ip_address" : "4",
    "acct_start_delay" : 0,
    "acct_stop_delay" : 0,
    "ssid" : "4",
    "identity" : "4",
    "nas_identifier" : "4",
    "mgmt_mac_address" : "4",
    "attribute_num" : 4,
    "event_time" : 4,
    "usage" : 1000
  }, {
    "id" : 6,
    "username" : "user5",
    "org_id" : 10,
    "timestamp" : 1615279279996,
    "vhm_id" : "vhm_5",
    "device_serial_number" : "123123123",
    "acct_session_id" : "5",
    "acct_multi_id" : "5",
    "group_name" : "group_5",
    "nas_ip_address" : "5",
    "nas_port" : "5",
    "nas_port_type" : "5",
    "acct_start_time" : 5,
    "acct_stop_time" : 5,
    "acct_session_time" : 5,
    "acct_authentic" : "5",
    "connect_info" : "5",
    "acct_input_octets" : 5,
    "acct_output_octets" : 5,
    "called_station_id" : "5",
    "calling_station_id" : "5",
    "acct_terminate_cause" : "5",
    "service_type" : "5",
    "framed_ip_address" : "5",
    "acct_start_delay" : 0,
    "acct_stop_delay" : 0,
    "ssid" : "5",
    "identity" : "5",
    "nas_identifier" : "5",
    "mgmt_mac_address" : "5",
    "attribute_num" : 5,
    "event_time" : 5,
    "usage" : 1000
  }, {
    "id" : 7,
    "username" : "user6",
    "org_id" : 10,
    "timestamp" : 1615279279996,
    "vhm_id" : "vhm_6",
    "device_serial_number" : "123123123",
    "acct_session_id" : "6",
    "acct_multi_id" : "6",
    "group_name" : "group_6",
    "nas_ip_address" : "6",
    "nas_port" : "6",
    "nas_port_type" : "6",
    "acct_start_time" : 6,
    "acct_stop_time" : 6,
    "acct_session_time" : 6,
    "acct_authentic" : "6",
    "connect_info" : "6",
    "acct_input_octets" : 6,
    "acct_output_octets" : 6,
    "called_station_id" : "6",
    "calling_station_id" : "6",
    "acct_terminate_cause" : "6",
    "service_type" : "6",
    "framed_ip_address" : "6",
    "acct_start_delay" : 0,
    "acct_stop_delay" : 0,
    "ssid" : "6",
    "identity" : "6",
    "nas_identifier" : "6",
    "mgmt_mac_address" : "6",
    "attribute_num" : 6,
    "event_time" : 6,
    "usage" : 1000
  }, {
    "id" : 8,
    "username" : "user7",
    "org_id" : 10,
    "timestamp" : 1615279279996,
    "vhm_id" : "vhm_7",
    "device_serial_number" : "123123123",
    "acct_session_id" : "7",
    "acct_multi_id" : "7",
    "group_name" : "group_7",
    "nas_ip_address" : "7",
    "nas_port" : "7",
    "nas_port_type" : "7",
    "acct_start_time" : 7,
    "acct_stop_time" : 7,
    "acct_session_time" : 7,
    "acct_authentic" : "7",
    "connect_info" : "7",
    "acct_input_octets" : 7,
    "acct_output_octets" : 7,
    "called_station_id" : "7",
    "calling_station_id" : "7",
    "acct_terminate_cause" : "7",
    "service_type" : "7",
    "framed_ip_address" : "7",
    "acct_start_delay" : 0,
    "acct_stop_delay" : 0,
    "ssid" : "7",
    "identity" : "7",
    "nas_identifier" : "7",
    "mgmt_mac_address" : "7",
    "attribute_num" : 7,
    "event_time" : 7,
    "usage" : 1000
  }, {
    "id" : 9,
    "username" : "user8",
    "org_id" : 10,
    "timestamp" : 1615279279996,
    "vhm_id" : "vhm_8",
    "device_serial_number" : "123123123",
    "acct_session_id" : "8",
    "acct_multi_id" : "8",
    "group_name" : "group_8",
    "nas_ip_address" : "8",
    "nas_port" : "8",
    "nas_port_type" : "8",
    "acct_start_time" : 8,
    "acct_stop_time" : 8,
    "acct_session_time" : 8,
    "acct_authentic" : "8",
    "connect_info" : "8",
    "acct_input_octets" : 8,
    "acct_output_octets" : 8,
    "called_station_id" : "8",
    "calling_station_id" : "8",
    "acct_terminate_cause" : "8",
    "service_type" : "8",
    "framed_ip_address" : "8",
    "acct_start_delay" : 0,
    "acct_stop_delay" : 0,
    "ssid" : "8",
    "identity" : "8",
    "nas_identifier" : "8",
    "mgmt_mac_address" : "8",
    "attribute_num" : 8,
    "event_time" : 8,
    "usage" : 1000
  }, {
    "id" : 10,
    "username" : "user9",
    "org_id" : 10,
    "timestamp" : 1615279279996,
    "vhm_id" : "vhm_9",
    "device_serial_number" : "123123123",
    "acct_session_id" : "9",
    "acct_multi_id" : "9",
    "group_name" : "group_9",
    "nas_ip_address" : "9",
    "nas_port" : "9",
    "nas_port_type" : "9",
    "acct_start_time" : 9,
    "acct_stop_time" : 9,
    "acct_session_time" : 9,
    "acct_authentic" : "9",
    "connect_info" : "9",
    "acct_input_octets" : 9,
    "acct_output_octets" : 9,
    "called_station_id" : "9",
    "calling_station_id" : "9",
    "acct_terminate_cause" : "9",
    "service_type" : "9",
    "framed_ip_address" : "9",
    "acct_start_delay" : 0,
    "acct_stop_delay" : 0,
    "ssid" : "9",
    "identity" : "9",
    "nas_identifier" : "9",
    "mgmt_mac_address" : "9",
    "attribute_num" : 9,
    "event_time" : 9,
    "usage" : 1000
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/logs/accounting?page=1&limit=10&keyword=&startTime=&stopTime=&keyword=&startTime=&stopTime=' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1NiwiZXhwIjoxNzEyNzc4OTU2fQ.YK2B_1n7Yejw1oxXU_Pf9sbqlhuedoNtWjoi3bX0QRA' \
    -H 'Content-Type: application/json'

List audit logs

GET /logs/audit

Request Parameters

Parameter Description

page

Page number, min = 1

limit

Page Size, min = 1, max = 100

categories

Audit category

username

The user login name

startTime

The start time to query, epoch time in milliseconds since 1/1/1970

endTime

The end time to query, epoch time in milliseconds since 1/1/1970. Note: endTime - startTime must be no greater than 2592000000 (30 days)

keyword

The case-insensitive keyword to search in description

sortField

The field for sorting

sortOrder

The sorting order

HTTP Request

GET /logs/audit?page=1&limit=10&categories=&username=&startTime=1672502400000&endTime=1675094400000&keyword=&sortField=TIMESTAMP&sortOrder=DESC&categories=&username=&keyword= HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1NSwiZXhwIjoxNzEyNzc4OTU1fQ.J8Bg4vQS_yVzKsELIlQQyVxcx4F6HFflid30kc0YI2k
Content-Type: application/json

Response Fields

Path Type Description

page

Number

The current page number.

count

Number

The element count of the current page.

total_pages

Number

The total page number based on request page size.

total_count

Number

The total element count.

data[].id

Number

The audit log ID.

data[].category

String

The audit category.

data[].user_id

Number

The user ID.

data[].org_id

Number

The organization identifier, valid when enabling HIQ feature.

data[].code

Number

The audit log code.

data[].username

String

The user name.

data[].parameters

String

The audit log parameters.

data[].vhm_name

String

The VIQ name.

data[].timestamp

Number

The audit log timestamp.

data[].description

String

The audit log description summary

HTTP Response

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

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 2,
  "total_count" : 15,
  "data" : [ {
    "id" : 1,
    "category" : "ADMIN",
    "user_id" : 134592,
    "code" : 10001,
    "username" : "hmf888888+staging2@gmail.com",
    "vhm_name" : "XELF-Y993-QJ9Y-336J",
    "parameters" : "[ [ \\\"name\\\", \\\"Administrator\\\" ] ]",
    "org_id" : 10,
    "timestamp" : 1615279279996,
    "description" : "Logged in with privileges of admin group Administrator"
  }, {
    "id" : 2,
    "category" : "ADMIN",
    "user_id" : 134592,
    "code" : 10001,
    "username" : "hmf888888+staging2@gmail.com",
    "vhm_name" : "XELF-Y993-QJ9Y-336J",
    "parameters" : "[ [ \\\"name\\\", \\\"Administrator\\\" ] ]",
    "org_id" : 10,
    "timestamp" : 1615279279996,
    "description" : "Logged in with privileges of admin group Administrator"
  }, {
    "id" : 3,
    "category" : "ADMIN",
    "user_id" : 134592,
    "code" : 10001,
    "username" : "hmf888888+staging2@gmail.com",
    "vhm_name" : "XELF-Y993-QJ9Y-336J",
    "parameters" : "[ [ \\\"name\\\", \\\"Administrator\\\" ] ]",
    "org_id" : 10,
    "timestamp" : 1615279279996,
    "description" : "Logged in with privileges of admin group Administrator"
  }, {
    "id" : 4,
    "category" : "ADMIN",
    "user_id" : 134592,
    "code" : 10001,
    "username" : "hmf888888+staging2@gmail.com",
    "vhm_name" : "XELF-Y993-QJ9Y-336J",
    "parameters" : "[ [ \\\"name\\\", \\\"Administrator\\\" ] ]",
    "org_id" : 10,
    "timestamp" : 1615279279996,
    "description" : "Logged in with privileges of admin group Administrator"
  }, {
    "id" : 5,
    "category" : "ADMIN",
    "user_id" : 134592,
    "code" : 10001,
    "username" : "hmf888888+staging2@gmail.com",
    "vhm_name" : "XELF-Y993-QJ9Y-336J",
    "parameters" : "[ [ \\\"name\\\", \\\"Administrator\\\" ] ]",
    "org_id" : 10,
    "timestamp" : 1615279279996,
    "description" : "Logged in with privileges of admin group Administrator"
  }, {
    "id" : 6,
    "category" : "ADMIN",
    "user_id" : 134592,
    "code" : 10001,
    "username" : "hmf888888+staging2@gmail.com",
    "vhm_name" : "XELF-Y993-QJ9Y-336J",
    "parameters" : "[ [ \\\"name\\\", \\\"Administrator\\\" ] ]",
    "org_id" : 10,
    "timestamp" : 1615279279996,
    "description" : "Logged in with privileges of admin group Administrator"
  }, {
    "id" : 7,
    "category" : "ADMIN",
    "user_id" : 134592,
    "code" : 10001,
    "username" : "hmf888888+staging2@gmail.com",
    "vhm_name" : "XELF-Y993-QJ9Y-336J",
    "parameters" : "[ [ \\\"name\\\", \\\"Administrator\\\" ] ]",
    "org_id" : 10,
    "timestamp" : 1615279279996,
    "description" : "Logged in with privileges of admin group Administrator"
  }, {
    "id" : 8,
    "category" : "ADMIN",
    "user_id" : 134592,
    "code" : 10001,
    "username" : "hmf888888+staging2@gmail.com",
    "vhm_name" : "XELF-Y993-QJ9Y-336J",
    "parameters" : "[ [ \\\"name\\\", \\\"Administrator\\\" ] ]",
    "org_id" : 10,
    "timestamp" : 1615279279996,
    "description" : "Logged in with privileges of admin group Administrator"
  }, {
    "id" : 9,
    "category" : "ADMIN",
    "user_id" : 134592,
    "code" : 10001,
    "username" : "hmf888888+staging2@gmail.com",
    "vhm_name" : "XELF-Y993-QJ9Y-336J",
    "parameters" : "[ [ \\\"name\\\", \\\"Administrator\\\" ] ]",
    "org_id" : 10,
    "timestamp" : 1615279279996,
    "description" : "Logged in with privileges of admin group Administrator"
  }, {
    "id" : 10,
    "category" : "ADMIN",
    "user_id" : 134592,
    "code" : 10001,
    "username" : "hmf888888+staging2@gmail.com",
    "vhm_name" : "XELF-Y993-QJ9Y-336J",
    "parameters" : "[ [ \\\"name\\\", \\\"Administrator\\\" ] ]",
    "org_id" : 10,
    "timestamp" : 1615279279996,
    "description" : "Logged in with privileges of admin group Administrator"
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/logs/audit?page=1&limit=10&categories=&username=&startTime=1672502400000&endTime=1675094400000&keyword=&sortField=TIMESTAMP&sortOrder=DESC&categories=&username=&keyword=' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1NSwiZXhwIjoxNzEyNzc4OTU1fQ.J8Bg4vQS_yVzKsELIlQQyVxcx4F6HFflid30kc0YI2k' \
    -H 'Content-Type: application/json'

Audit logs Report

GET /logs/audit/report

Request Parameters

Parameter Description

categories

Audit category

username

The user login name

startTime

The start time to query, epoch time in milliseconds since 1/1/1970, default is 0 if not specified or is negative

endTime

The end time to query, epoch time in milliseconds since 1/1/1970, default is now if not specified or is negative, endTime - startTime must be no greater than 2592000000 (30 days)

keyword

The case-insensitive keyword to search in description

sortField

The field for sorting

sortOrder

The sorting order

timeZoneOffset

The time zone off set

HTTP Request

POST /logs/audit/reports HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1NSwiZXhwIjoxNzEyNzc4OTU1fQ.J8Bg4vQS_yVzKsELIlQQyVxcx4F6HFflid30kc0YI2k
Content-Type: application/json

categories=&username=&startTime=1672502400000&endTime=1675094400000&keyword=&sortField=TIMESTAMP&sortOrder=DESC&timeZoneOffset=-330

Response Fields

Path Type Description

id

Number

The audit log report ID.

HTTP Response

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

{
  "id" : 1712174155
}

cURL Request

$ curl 'https://api.extremecloudiq.com/logs/audit/reports' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1NSwiZXhwIjoxNzEyNzc4OTU1fQ.J8Bg4vQS_yVzKsELIlQQyVxcx4F6HFflid30kc0YI2k' \
    -H 'Content-Type: application/json' \
    -d 'categories=&username=&startTime=1672502400000&endTime=1675094400000&keyword=&sortField=TIMESTAMP&sortOrder=DESC&timeZoneOffset=-330'

List authentication logs

GET /logs/auth

Request Parameters

Parameter Description

page

Page number

limit

Page size

keyword

The keyword

startTime

start time

stopTime

stop time

HTTP Request

GET /logs/auth?page=1&limit=10&keyword=&startTime=&stopTime=&keyword=&startTime=&stopTime= HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1NiwiZXhwIjoxNzEyNzc4OTU2fQ.YK2B_1n7Yejw1oxXU_Pf9sbqlhuedoNtWjoi3bX0QRA
Content-Type: application/json

Response Fields

Path Type Description

page

Number

The current page number.

count

Number

The element count of the current page.

total_pages

Number

The total page number based on request page size.

total_count

Number

The total element count.

data[].id

String

The audit log ID.

data[].auth_date

Number

The authentication date.

data[].sn

String

The serial number.

data[].org_id

Number

The organization identifier, valid when enabling HIQ feature.

data[].ssid

String

The ssid.

data[].reject_reason

String

The reject reason.

data[].nas_port_type

String

The nas port type.

data[].vhm_id

String

The vhm id.

data[].nas_identifier

String

The nas identifier.

data[].reply

String

The reply.

data[].mgmt_mac_address

String

The management mac address.

data[].calling_station_id

String

The calling station id.

data[].called_station_id

String

The called station id.

data[].auth_type

String

The auth type.

data[].username

String

The username.

data[].identity

String

The identity.

data[].timestamp

Number

The timestamp.

HTTP Response

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

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 2,
  "total_count" : 15,
  "data" : [ {
    "id" : "sRuR1rcI3Fyms5niOGqo",
    "auth_type" : "123",
    "sn" : "123123123",
    "vhm_id" : "VHM_ID",
    "username" : "hmf888888+staging2@gmail.com",
    "reply" : "reply-test",
    "called_station_id" : "called_id",
    "calling_station_id" : "calling_id",
    "auth_date" : 1615279279996,
    "ssid" : "ssid-test",
    "identity" : "id-1",
    "nas_port_type" : "port1",
    "reject_reason" : "na",
    "nas_identifier" : "nas-id",
    "mgmt_mac_address" : "mac_address",
    "org_id" : 10,
    "timestamp" : 1615279279996
  }, {
    "id" : "ArxkvJBUb0kYd0EQBMQX",
    "auth_type" : "123",
    "sn" : "123123123",
    "vhm_id" : "VHM_ID",
    "username" : "hmf888888+staging2@gmail.com",
    "reply" : "reply-test",
    "called_station_id" : "called_id",
    "calling_station_id" : "calling_id",
    "auth_date" : 1615279279996,
    "ssid" : "ssid-test",
    "identity" : "id-1",
    "nas_port_type" : "port1",
    "reject_reason" : "na",
    "nas_identifier" : "nas-id",
    "mgmt_mac_address" : "mac_address",
    "org_id" : 10,
    "timestamp" : 1615279279996
  }, {
    "id" : "17jWWlgqCkN4TAUgHlYV",
    "auth_type" : "123",
    "sn" : "123123123",
    "vhm_id" : "VHM_ID",
    "username" : "hmf888888+staging2@gmail.com",
    "reply" : "reply-test",
    "called_station_id" : "called_id",
    "calling_station_id" : "calling_id",
    "auth_date" : 1615279279996,
    "ssid" : "ssid-test",
    "identity" : "id-1",
    "nas_port_type" : "port1",
    "reject_reason" : "na",
    "nas_identifier" : "nas-id",
    "mgmt_mac_address" : "mac_address",
    "org_id" : 10,
    "timestamp" : 1615279279996
  }, {
    "id" : "Izl5Kk7l2d9pLloj6cKh",
    "auth_type" : "123",
    "sn" : "123123123",
    "vhm_id" : "VHM_ID",
    "username" : "hmf888888+staging2@gmail.com",
    "reply" : "reply-test",
    "called_station_id" : "called_id",
    "calling_station_id" : "calling_id",
    "auth_date" : 1615279279996,
    "ssid" : "ssid-test",
    "identity" : "id-1",
    "nas_port_type" : "port1",
    "reject_reason" : "na",
    "nas_identifier" : "nas-id",
    "mgmt_mac_address" : "mac_address",
    "org_id" : 10,
    "timestamp" : 1615279279996
  }, {
    "id" : "1iJ9cLv4eAlH2Mw7OMpf",
    "auth_type" : "123",
    "sn" : "123123123",
    "vhm_id" : "VHM_ID",
    "username" : "hmf888888+staging2@gmail.com",
    "reply" : "reply-test",
    "called_station_id" : "called_id",
    "calling_station_id" : "calling_id",
    "auth_date" : 1615279279996,
    "ssid" : "ssid-test",
    "identity" : "id-1",
    "nas_port_type" : "port1",
    "reject_reason" : "na",
    "nas_identifier" : "nas-id",
    "mgmt_mac_address" : "mac_address",
    "org_id" : 10,
    "timestamp" : 1615279279996
  }, {
    "id" : "zDnWuHpEQLTXNpQIahGL",
    "auth_type" : "123",
    "sn" : "123123123",
    "vhm_id" : "VHM_ID",
    "username" : "hmf888888+staging2@gmail.com",
    "reply" : "reply-test",
    "called_station_id" : "called_id",
    "calling_station_id" : "calling_id",
    "auth_date" : 1615279279996,
    "ssid" : "ssid-test",
    "identity" : "id-1",
    "nas_port_type" : "port1",
    "reject_reason" : "na",
    "nas_identifier" : "nas-id",
    "mgmt_mac_address" : "mac_address",
    "org_id" : 10,
    "timestamp" : 1615279279996
  }, {
    "id" : "A0s4p4Tx874saaw447Br",
    "auth_type" : "123",
    "sn" : "123123123",
    "vhm_id" : "VHM_ID",
    "username" : "hmf888888+staging2@gmail.com",
    "reply" : "reply-test",
    "called_station_id" : "called_id",
    "calling_station_id" : "calling_id",
    "auth_date" : 1615279279996,
    "ssid" : "ssid-test",
    "identity" : "id-1",
    "nas_port_type" : "port1",
    "reject_reason" : "na",
    "nas_identifier" : "nas-id",
    "mgmt_mac_address" : "mac_address",
    "org_id" : 10,
    "timestamp" : 1615279279996
  }, {
    "id" : "9pEYiC6iCs2saxFPFIW2",
    "auth_type" : "123",
    "sn" : "123123123",
    "vhm_id" : "VHM_ID",
    "username" : "hmf888888+staging2@gmail.com",
    "reply" : "reply-test",
    "called_station_id" : "called_id",
    "calling_station_id" : "calling_id",
    "auth_date" : 1615279279996,
    "ssid" : "ssid-test",
    "identity" : "id-1",
    "nas_port_type" : "port1",
    "reject_reason" : "na",
    "nas_identifier" : "nas-id",
    "mgmt_mac_address" : "mac_address",
    "org_id" : 10,
    "timestamp" : 1615279279996
  }, {
    "id" : "Xh8aqX9YNARsi9K03pLA",
    "auth_type" : "123",
    "sn" : "123123123",
    "vhm_id" : "VHM_ID",
    "username" : "hmf888888+staging2@gmail.com",
    "reply" : "reply-test",
    "called_station_id" : "called_id",
    "calling_station_id" : "calling_id",
    "auth_date" : 1615279279996,
    "ssid" : "ssid-test",
    "identity" : "id-1",
    "nas_port_type" : "port1",
    "reject_reason" : "na",
    "nas_identifier" : "nas-id",
    "mgmt_mac_address" : "mac_address",
    "org_id" : 10,
    "timestamp" : 1615279279996
  }, {
    "id" : "ENx2DriucwRo8zQ5Ofjb",
    "auth_type" : "123",
    "sn" : "123123123",
    "vhm_id" : "VHM_ID",
    "username" : "hmf888888+staging2@gmail.com",
    "reply" : "reply-test",
    "called_station_id" : "called_id",
    "calling_station_id" : "calling_id",
    "auth_date" : 1615279279996,
    "ssid" : "ssid-test",
    "identity" : "id-1",
    "nas_port_type" : "port1",
    "reject_reason" : "na",
    "nas_identifier" : "nas-id",
    "mgmt_mac_address" : "mac_address",
    "org_id" : 10,
    "timestamp" : 1615279279996
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/logs/auth?page=1&limit=10&keyword=&startTime=&stopTime=&keyword=&startTime=&stopTime=' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1NiwiZXhwIjoxNzEyNzc4OTU2fQ.YK2B_1n7Yejw1oxXU_Pf9sbqlhuedoNtWjoi3bX0QRA' \
    -H 'Content-Type: application/json'

List credential logs

GET /logs/credential

Request Parameters

Parameter Description

page

Page number

limit

Page size

keyword

The keyword

startTime

start time

stopTime

stop time

HTTP Request

GET /logs/credential?page=1&limit=10&keyword=&startTime=&stopTime=&keyword=&startTime=&stopTime= HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1NywiZXhwIjoxNzEyNzc4OTU3fQ.W3iVJfD9-qD9cBJduHe9XKo1OifM07NR6bY3PWSMPbg

Response Fields

Path Type Description

page

Number

The current page number.

count

Number

The element count of the current page.

total_pages

Number

The total page number based on request page size.

total_count

Number

The total element count.

data[].id

Number

The Credential log ID.

data[].org_id

Number

The organization identifier, valid when enabling HIQ feature.

data[].username

String

The username.

data[].vhm_id

String

The vhmd id.

data[].timestamp

Number

The timestamp.

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: 1331
X-Content-Type-Options: nosniff
RateLimit-Remaining: 7328
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 2,
  "total_count" : 15,
  "data" : [ {
    "id" : 1,
    "username" : "user0",
    "vhm_id" : "vhm_id0",
    "org_id" : 10,
    "timestamp" : 1615279279996
  }, {
    "id" : 2,
    "username" : "user1",
    "vhm_id" : "vhm_id1",
    "org_id" : 10,
    "timestamp" : 1615279279996
  }, {
    "id" : 3,
    "username" : "user2",
    "vhm_id" : "vhm_id2",
    "org_id" : 10,
    "timestamp" : 1615279279996
  }, {
    "id" : 4,
    "username" : "user3",
    "vhm_id" : "vhm_id3",
    "org_id" : 10,
    "timestamp" : 1615279279996
  }, {
    "id" : 5,
    "username" : "user4",
    "vhm_id" : "vhm_id4",
    "org_id" : 10,
    "timestamp" : 1615279279996
  }, {
    "id" : 6,
    "username" : "user5",
    "vhm_id" : "vhm_id5",
    "org_id" : 10,
    "timestamp" : 1615279279996
  }, {
    "id" : 7,
    "username" : "user6",
    "vhm_id" : "vhm_id6",
    "org_id" : 10,
    "timestamp" : 1615279279996
  }, {
    "id" : 8,
    "username" : "user7",
    "vhm_id" : "vhm_id7",
    "org_id" : 10,
    "timestamp" : 1615279279996
  }, {
    "id" : 9,
    "username" : "user8",
    "vhm_id" : "vhm_id8",
    "org_id" : 10,
    "timestamp" : 1615279279996
  }, {
    "id" : 10,
    "username" : "user9",
    "vhm_id" : "vhm_id9",
    "org_id" : 10,
    "timestamp" : 1615279279996
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/logs/credential?page=1&limit=10&keyword=&startTime=&stopTime=&keyword=&startTime=&stopTime=' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1NywiZXhwIjoxNzEyNzc4OTU3fQ.W3iVJfD9-qD9cBJduHe9XKo1OifM07NR6bY3PWSMPbg'

List Email logs

GET /logs/email

Request Parameters

Parameter Description

page

Page number

limit

Page size

keyword

The keyword

startTime

start time

stopTime

stop time

HTTP Request

GET /logs/email?page=1&limit=10&keyword=&startTime=&stopTime=&keyword=&startTime=&stopTime= HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1NSwiZXhwIjoxNzEyNzc4OTU1fQ.J8Bg4vQS_yVzKsELIlQQyVxcx4F6HFflid30kc0YI2k
Content-Type: application/json

Response Fields

Path Type Description

page

Number

The current page number.

count

Number

The element count of the current page.

total_pages

Number

The total page number based on request page size.

total_count

Number

The total element count.

data[].id

Number

The Email log ID.

data[].org_id

Number

The organization identifier, valid when enabling HIQ feature.

data[].username

String

The username.

data[].approver_email

String

The approver email.

data[].user_id

Number

The user id.

data[].customer_id

String

The customer id.

data[].status

String

The email log status.

data[].timestamp

Number

The timestamp.

HTTP Response

HTTP/1.1 200 OK
RateLimit-Remaining: 7330
Content-Length: 2141
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

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 2,
  "total_count" : 15,
  "data" : [ {
    "id" : 1,
    "username" : "user0",
    "org_id" : 10,
    "timestamp" : 1615279279996,
    "user_id" : 0,
    "customer_id" : "customer0",
    "approver_email" : "email0",
    "status" : "app"
  }, {
    "id" : 2,
    "username" : "user1",
    "org_id" : 10,
    "timestamp" : 1615279279996,
    "user_id" : 1,
    "customer_id" : "customer1",
    "approver_email" : "email1",
    "status" : "app"
  }, {
    "id" : 3,
    "username" : "user2",
    "org_id" : 10,
    "timestamp" : 1615279279996,
    "user_id" : 2,
    "customer_id" : "customer2",
    "approver_email" : "email2",
    "status" : "app"
  }, {
    "id" : 4,
    "username" : "user3",
    "org_id" : 10,
    "timestamp" : 1615279279996,
    "user_id" : 3,
    "customer_id" : "customer3",
    "approver_email" : "email3",
    "status" : "app"
  }, {
    "id" : 5,
    "username" : "user4",
    "org_id" : 10,
    "timestamp" : 1615279279996,
    "user_id" : 4,
    "customer_id" : "customer4",
    "approver_email" : "email4",
    "status" : "app"
  }, {
    "id" : 6,
    "username" : "user5",
    "org_id" : 10,
    "timestamp" : 1615279279996,
    "user_id" : 5,
    "customer_id" : "customer5",
    "approver_email" : "email5",
    "status" : "app"
  }, {
    "id" : 7,
    "username" : "user6",
    "org_id" : 10,
    "timestamp" : 1615279279996,
    "user_id" : 6,
    "customer_id" : "customer6",
    "approver_email" : "email6",
    "status" : "app"
  }, {
    "id" : 8,
    "username" : "user7",
    "org_id" : 10,
    "timestamp" : 1615279279996,
    "user_id" : 7,
    "customer_id" : "customer7",
    "approver_email" : "email7",
    "status" : "app"
  }, {
    "id" : 9,
    "username" : "user8",
    "org_id" : 10,
    "timestamp" : 1615279279996,
    "user_id" : 8,
    "customer_id" : "customer8",
    "approver_email" : "email8",
    "status" : "app"
  }, {
    "id" : 10,
    "username" : "user9",
    "org_id" : 10,
    "timestamp" : 1615279279996,
    "user_id" : 9,
    "customer_id" : "customer9",
    "approver_email" : "email9",
    "status" : "app"
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/logs/email?page=1&limit=10&keyword=&startTime=&stopTime=&keyword=&startTime=&stopTime=' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1NSwiZXhwIjoxNzEyNzc4OTU1fQ.J8Bg4vQS_yVzKsELIlQQyVxcx4F6HFflid30kc0YI2k' \
    -H 'Content-Type: application/json'

List SMS logs

GET /logs/sms

Request Parameters

Parameter Description

page

Page number

limit

Page size

phoneNumber

The phone number

startTime

start time

stopTime

stop time

HTTP Request

GET /logs/sms?page=1&limit=10&phoneNumber=&startTime=&stopTime=&phoneNumber=&startTime=&stopTime= HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1NiwiZXhwIjoxNzEyNzc4OTU2fQ.YK2B_1n7Yejw1oxXU_Pf9sbqlhuedoNtWjoi3bX0QRA
Content-Type: application/json

Response Fields

Path Type Description

page

Number

The current page number.

count

Number

The element count of the current page.

total_pages

Number

The total page number based on request page size.

total_count

Number

The total element count.

data[].id

Number

The sms log ID.

data[].user_id

Number

The user id.

data[].customer_id

String

The customer id.

data[].org_id

Number

The organization identifier, valid when enabling HIQ feature.

data[].tel

String

The phone number.

data[].profile_name

String

The profile name.

data[].status

String

The SMS log status.

data[].message_id

String

The message id.

data[].status_from_provider

String

The status from provider.

data[].provider_type

String

The provider type.

data[].timestamp

Number

The timestamp.

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

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 2,
  "total_count" : 15,
  "data" : [ {
    "id" : 1,
    "user_id" : 0,
    "customer_id" : "0",
    "tel" : "0",
    "profile_name" : "name0",
    "status" : "SUCCESS",
    "message_id" : "0",
    "status_from_provider" : "status0",
    "provider_type" : "t1",
    "org_id" : 10,
    "timestamp" : 1615279279996
  }, {
    "id" : 2,
    "user_id" : 1,
    "customer_id" : "1",
    "tel" : "1",
    "profile_name" : "name1",
    "status" : "SUCCESS",
    "message_id" : "1",
    "status_from_provider" : "status1",
    "provider_type" : "t1",
    "org_id" : 10,
    "timestamp" : 1615279279996
  }, {
    "id" : 3,
    "user_id" : 2,
    "customer_id" : "2",
    "tel" : "2",
    "profile_name" : "name2",
    "status" : "SUCCESS",
    "message_id" : "2",
    "status_from_provider" : "status2",
    "provider_type" : "t1",
    "org_id" : 10,
    "timestamp" : 1615279279996
  }, {
    "id" : 4,
    "user_id" : 3,
    "customer_id" : "3",
    "tel" : "3",
    "profile_name" : "name3",
    "status" : "SUCCESS",
    "message_id" : "3",
    "status_from_provider" : "status3",
    "provider_type" : "t1",
    "org_id" : 10,
    "timestamp" : 1615279279996
  }, {
    "id" : 5,
    "user_id" : 4,
    "customer_id" : "4",
    "tel" : "4",
    "profile_name" : "name4",
    "status" : "SUCCESS",
    "message_id" : "4",
    "status_from_provider" : "status4",
    "provider_type" : "t1",
    "org_id" : 10,
    "timestamp" : 1615279279996
  }, {
    "id" : 6,
    "user_id" : 5,
    "customer_id" : "5",
    "tel" : "5",
    "profile_name" : "name5",
    "status" : "SUCCESS",
    "message_id" : "5",
    "status_from_provider" : "status5",
    "provider_type" : "t1",
    "org_id" : 10,
    "timestamp" : 1615279279996
  }, {
    "id" : 7,
    "user_id" : 6,
    "customer_id" : "6",
    "tel" : "6",
    "profile_name" : "name6",
    "status" : "SUCCESS",
    "message_id" : "6",
    "status_from_provider" : "status6",
    "provider_type" : "t1",
    "org_id" : 10,
    "timestamp" : 1615279279996
  }, {
    "id" : 8,
    "user_id" : 7,
    "customer_id" : "7",
    "tel" : "7",
    "profile_name" : "name7",
    "status" : "SUCCESS",
    "message_id" : "7",
    "status_from_provider" : "status7",
    "provider_type" : "t1",
    "org_id" : 10,
    "timestamp" : 1615279279996
  }, {
    "id" : 9,
    "user_id" : 8,
    "customer_id" : "8",
    "tel" : "8",
    "profile_name" : "name8",
    "status" : "SUCCESS",
    "message_id" : "8",
    "status_from_provider" : "status8",
    "provider_type" : "t1",
    "org_id" : 10,
    "timestamp" : 1615279279996
  }, {
    "id" : 10,
    "user_id" : 9,
    "customer_id" : "9",
    "tel" : "9",
    "profile_name" : "name9",
    "status" : "SUCCESS",
    "message_id" : "9",
    "status_from_provider" : "status9",
    "provider_type" : "t1",
    "org_id" : 10,
    "timestamp" : 1615279279996
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/logs/sms?page=1&limit=10&phoneNumber=&startTime=&stopTime=&phoneNumber=&startTime=&stopTime=' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1NiwiZXhwIjoxNzEyNzc4OTU2fQ.YK2B_1n7Yejw1oxXU_Pf9sbqlhuedoNtWjoi3bX0QRA' \
    -H 'Content-Type: application/json'

Notification

List webhook subscriptions

GET /subscriptions/webhook

HTTP Request

GET /subscriptions/webhook HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1NSwiZXhwIjoxNzEyNzc4OTU1fQ.J8Bg4vQS_yVzKsELIlQQyVxcx4F6HFflid30kc0YI2k
Content-Type: application/json

Response Fields

Path Type Description

[].id

Number

The subscription ID.

[].create_time

String

The create time.

[].update_time

String

The update time.

[].application

String

The external application name.

[].url

String

The webhook endpoint URL.

[].secret

String

The basic auth secret for the webhook endpoint.

[].data_type

String

The subscription data type.

[].message_type

String

The subscription message type.

[].status

String

The subscription status.

HTTP Response

HTTP/1.1 200 OK
RateLimit-Remaining: 7331
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: 2933

[ {
  "id" : 1,
  "create_time" : "2024-04-03T19:55:55.000+0000",
  "update_time" : "2024-04-03T19:55:55.000+0000",
  "application" : "foo_0",
  "url" : "https://foo.com/SddMj",
  "secret" : "wbFzFXj0E5",
  "data_type" : "LOCATION",
  "message_type" : "AUDIT_LOG_ALL",
  "status" : "ENABLED"
}, {
  "id" : 2,
  "create_time" : "2024-04-03T19:55:55.000+0000",
  "update_time" : "2024-04-03T19:55:55.000+0000",
  "application" : "foo_1",
  "url" : "https://foo.com/msbAR",
  "secret" : "U8iQPYvOly",
  "data_type" : "LOCATION",
  "message_type" : "AUDIT_LOG_ALL",
  "status" : "ENABLED"
}, {
  "id" : 3,
  "create_time" : "2024-04-03T19:55:55.000+0000",
  "update_time" : "2024-04-03T19:55:55.000+0000",
  "application" : "foo_2",
  "url" : "https://foo.com/CTJJW",
  "secret" : "r0oHZv2chp",
  "data_type" : "LOCATION",
  "message_type" : "AUDIT_LOG_ALL",
  "status" : "ENABLED"
}, {
  "id" : 4,
  "create_time" : "2024-04-03T19:55:55.000+0000",
  "update_time" : "2024-04-03T19:55:55.000+0000",
  "application" : "foo_3",
  "url" : "https://foo.com/UplUB",
  "secret" : "FM6ipCEE4G",
  "data_type" : "LOCATION",
  "message_type" : "AUDIT_LOG_ALL",
  "status" : "ENABLED"
}, {
  "id" : 5,
  "create_time" : "2024-04-03T19:55:55.000+0000",
  "update_time" : "2024-04-03T19:55:55.000+0000",
  "application" : "foo_4",
  "url" : "https://foo.com/vQsuN",
  "secret" : "ZhLbaUOMm5",
  "data_type" : "LOCATION",
  "message_type" : "AUDIT_LOG_ALL",
  "status" : "ENABLED"
}, {
  "id" : 6,
  "create_time" : "2024-04-03T19:55:55.000+0000",
  "update_time" : "2024-04-03T19:55:55.000+0000",
  "application" : "foo_5",
  "url" : "https://foo.com/GYgUy",
  "secret" : "Bzuf9XUClU",
  "data_type" : "LOCATION",
  "message_type" : "AUDIT_LOG_ALL",
  "status" : "ENABLED"
}, {
  "id" : 7,
  "create_time" : "2024-04-03T19:55:55.000+0000",
  "update_time" : "2024-04-03T19:55:55.000+0000",
  "application" : "foo_6",
  "url" : "https://foo.com/dANkU",
  "secret" : "RK1cNRXf3D",
  "data_type" : "LOCATION",
  "message_type" : "AUDIT_LOG_ALL",
  "status" : "ENABLED"
}, {
  "id" : 8,
  "create_time" : "2024-04-03T19:55:55.000+0000",
  "update_time" : "2024-04-03T19:55:55.000+0000",
  "application" : "foo_7",
  "url" : "https://foo.com/MDSme",
  "secret" : "6zsQYNbHC5",
  "data_type" : "LOCATION",
  "message_type" : "AUDIT_LOG_ALL",
  "status" : "ENABLED"
}, {
  "id" : 9,
  "create_time" : "2024-04-03T19:55:55.000+0000",
  "update_time" : "2024-04-03T19:55:55.000+0000",
  "application" : "foo_8",
  "url" : "https://foo.com/CPBoT",
  "secret" : "38Pl3LYnie",
  "data_type" : "LOCATION",
  "message_type" : "AUDIT_LOG_ALL",
  "status" : "ENABLED"
}, {
  "id" : 10,
  "create_time" : "2024-04-03T19:55:55.000+0000",
  "update_time" : "2024-04-03T19:55:55.000+0000",
  "application" : "foo_9",
  "url" : "https://foo.com/ZBFGe",
  "secret" : "gdhC5MxDSF",
  "data_type" : "LOCATION",
  "message_type" : "AUDIT_LOG_ALL",
  "status" : "ENABLED"
} ]

cURL Request

$ curl 'https://api.extremecloudiq.com/subscriptions/webhook' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1NSwiZXhwIjoxNzEyNzc4OTU1fQ.J8Bg4vQS_yVzKsELIlQQyVxcx4F6HFflid30kc0YI2k' \
    -H 'Content-Type: application/json'

Create webhook subscriptions

POST /subscriptions/webhook

Request Fields

Path Type Description

[]

Array

The webhook subscriptions info

[].application

String

The external application name.

[].url

String

The external application URL.

[].secret

String

The external subscriber basic auth secret.

[].message_type

String

The subscription message type.

HTTP Request

POST /subscriptions/webhook HTTP/1.1
Host: api.extremecloudiq.com
Content-Length: 150
Content-Type: application/json
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1NCwiZXhwIjoxNzEyNzc4OTU0fQ.7nL9CfjkYz9niOBsAh6ybrHVyIQ6vMbPedpuZEkHyc8

[ {
  "application" : "Mock subscriber",
  "url" : "http://localhost:8080/api/auditlog",
  "secret" : "xxxxxx",
  "message_type" : "AUDIT_LOG_ALL"
} ]

HTTP Response

HTTP/1.1 202 Accepted
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
RateLimit-Remaining: 7333
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/subscriptions/webhook' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1NCwiZXhwIjoxNzEyNzc4OTU0fQ.7nL9CfjkYz9niOBsAh6ybrHVyIQ6vMbPedpuZEkHyc8' \
    -d '[ {
  "application" : "Mock subscriber",
  "url" : "http://localhost:8080/api/auditlog",
  "secret" : "xxxxxx",
  "message_type" : "AUDIT_LOG_ALL"
} ]'

Delete webhook subscriptions

DELETE /subscriptions/webhook/{id}

Path Parameters

Table 76. /subscriptions/webhook/{id}
Parameter	Description
`id`	The webhook subscription ID

HTTP Request

DELETE /subscriptions/webhook/1 HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1NCwiZXhwIjoxNzEyNzc4OTU0fQ.7nL9CfjkYz9niOBsAh6ybrHVyIQ6vMbPedpuZEkHyc8

HTTP Response

HTTP/1.1 202 Accepted
Pragma: no-cache
RateLimit-Remaining: 7332
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/subscriptions/webhook/1' -i -X DELETE \
    -H 'Content-Type: application/json' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE1NCwiZXhwIjoxNzEyNzc4OTU0fQ.7nL9CfjkYz9niOBsAh6ybrHVyIQ6vMbPedpuZEkHyc8'

Configuration - Deployment

Push configuration and upgrade firmware to devices

POST /deployments

Request Fields

Path Type Description

devices.ids[]

Array

The device ID list.

policy

Object

Configuration update type.

policy.enable_complete_configuration_update

Boolean

true if update complete configuration, otherwise update delta configuration. Note: ExtremeCloud IQ will neither upgrade device firmware nor reboot device for a delta configuration push. That means that the other parameters for firmware upgrade and activation are not required when this is false.

policy.firmware_upgrade_policy

Object

Firmware upgrade policy.

policy.firmware_activate_option

Object

Firmware activate option.

policy.firmware_upgrade_policy.enable_enforce_upgrade

Boolean

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

policy.firmware_upgrade_policy.enable_distributed_upgrade

Boolean

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

policy.firmware_activate_option.enable_activate_at_next_reboot

Boolean

Activate at next reboot (requires rebooting manually).

policy.firmware_activate_option.activation_delay_seconds

Number

Activate after the given seconds.

policy.firmware_activate_option.activation_time

Number

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

HTTP Request

POST /deployments HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEzMCwiZXhwIjoxNzEyNzc4OTMwfQ.tvh-FvYhhgcM61Oiz8d-_7zAMalahBdIahIJ__lB67k
Content-Type: application/json
Content-Length: 431

{
  "devices" : {
    "ids" : [ 438086664193, 438086664194, 438086664195 ]
  },
  "policy" : {
    "enable_complete_configuration_update" : true,
    "firmware_upgrade_policy" : {
      "enable_enforce_upgrade" : false,
      "enable_distributed_upgrade" : false
    },
    "firmware_activate_option" : {
      "enable_activate_at_next_reboot" : false,
      "activation_delay_seconds" : 30,
      "activation_time" : 0
    }
  }
}

Response Fields

Path Type Description

request_id

Number

The request ID.

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Content-Length: 22
RateLimit-Remaining: 7378
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

{
  "request_id" : 1
}

cURL Request

$ curl 'https://api.extremecloudiq.com/deployments' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEzMCwiZXhwIjoxNzEyNzc4OTMwfQ.tvh-FvYhhgcM61Oiz8d-_7zAMalahBdIahIJ__lB67k' \
    -H 'Content-Type: application/json' \
    -d '{
  "devices" : {
    "ids" : [ 438086664193, 438086664194, 438086664195 ]
  },
  "policy" : {
    "enable_complete_configuration_update" : true,
    "firmware_upgrade_policy" : {
      "enable_enforce_upgrade" : false,
      "enable_distributed_upgrade" : false
    },
    "firmware_activate_option" : {
      "enable_activate_at_next_reboot" : false,
      "activation_delay_seconds" : 30,
      "activation_time" : 0
    }
  }
}'

Get configuration deployment overview

GET /deployments/overview

HTTP Request

GET /deployments/overview HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEzMCwiZXhwIjoxNzEyNzc4OTMwfQ.tvh-FvYhhgcM61Oiz8d-_7zAMalahBdIahIJ__lB67k
Content-Type: application/json

Response Fields

Path Type Description

in_progress_devices

Number

The device count with in progress deployment.

total_progress

Number

The total progress of devices being updated, that ranges from 0 to 100. If there is no device being updated, the total progress is 100.

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
RateLimit-Remaining: 7377
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: 57

{
  "in_progress_devices" : 10,
  "total_progress" : 50
}

cURL Request

$ curl 'https://api.extremecloudiq.com/deployments/overview' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEzMCwiZXhwIjoxNzEyNzc4OTMwfQ.tvh-FvYhhgcM61Oiz8d-_7zAMalahBdIahIJ__lB67k' \
    -H 'Content-Type: application/json'

Get configuration deployment status

GET /deployments/status

Request Parameters

Parameter Description

deviceIds

The target device IDs

HTTP Request

GET /deployments/status?deviceIds=438086664193&deviceIds=438086664194 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEzMCwiZXhwIjoxNzEyNzc4OTMwfQ.tvh-FvYhhgcM61Oiz8d-_7zAMalahBdIahIJ__lB67k
Content-Type: application/json

Response Fields

Path Type Description

*.finished

Boolean

Indicates whether the last deployment is finished.

*.current_progress

Number

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

*.current_step_code

String

The code of the current deploy step if not finished.

*.current_step_message

String

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

*.is_finished_successful

Boolean

Indicates whether the last deployment is successful if finished.

*.last_deploy_time

Number

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

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
RateLimit-Remaining: 7378
Expires: 0
X-Content-Type-Options: nosniff
Content-Length: 116
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" : {
    "is_finished_successful" : true,
    "last_deploy_time" : 1712174130591,
    "finished" : true
  }
}

cURL Request

$ curl 'https://api.extremecloudiq.com/deployments/status?deviceIds=438086664193&deviceIds=438086664194' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEzMCwiZXhwIjoxNzEyNzc4OTMwfQ.tvh-FvYhhgcM61Oiz8d-_7zAMalahBdIahIJ__lB67k' \
    -H 'Content-Type: application/json'

Configuration - Basic

List VLAN profiles

GET /vlan-profiles

Request Parameters

Parameter Description

page

Page number

limit

Page size

HTTP Request

GET /vlan-profiles?page=1&limit=10 HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNCwiZXhwIjoxNzEyNzc4OTI0fQ.T0Vfd2v4NVXRKrv9Jc93gl5VztjKcLQpN6EqDDMKIyU

Response Fields

Path Type Description

page

Number

The current page number.

count

Number

The element count of the current page.

total_pages

Number

The total page number based on request page size.

total_count

Number

The total element count.

data[].id

Number

The vlan profile ID.

data[].org_id

Number

The vlan profile org ID.

data[].create_time

String

The create time.

data[].update_time

String

The last update time.

data[].name

String

The name of vlan profile.

data[].default_vlan_id

Number

The default vlan ID.

data[].enable_classification

Boolean

Apply VLANs to devices using classification.

data[].classified_entries[].id

Number

The classified entry ID.

data[].classified_entries[].org_id

Number

The classified entry ID.

data[].classified_entries[].create_time

String

The create time.

data[].classified_entries[].update_time

String

The last update time.

data[].classified_entries[].vlan_id

Number

The vlan ID.

data[].classified_entries[].classification_rule.id

Number

The classification assignment id.

data[].classified_entries[].classification_rule.org_id

Number

The classification assignment id.

data[].classified_entries[].classification_rule.name

String

The classification assignment name.

data[].classified_entries[].classification_rule.description

String

The classification assignment description.

data[].classified_entries[].classification_rule.create_time

String

The classification assignment create time.

data[].classified_entries[].classification_rule.update_time

String

The classification assignment update time.

data[].classified_entries[].classification_rule.classifications[].id

Number

The classification id.

data[].classified_entries[].classification_rule.classifications[].match

Boolean

Match or not match with classification.

data[].classified_entries[].classification_rule.classifications[].value

String

The value of classification.

data[].classified_entries[].classification_rule.classifications[].create_time

String

The create time.

data[].classified_entries[].classification_rule.classifications[].update_time

String

The last update time.

data[].classified_entries[].classification_rule.classifications[].classification_type

String

The classification type.

data[].classified_entries[].classification_rule.classifications[].classification_id

Number

The classification reference ID.

HTTP Response

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

{
  "page" : 1,
  "count" : 0,
  "total_pages" : 0,
  "total_count" : 0,
  "data" : [ {
    "id" : 0,
    "create_time" : "1970-01-01T00:00:00.000+0000",
    "update_time" : "1970-01-01T00:00:00.000+0000",
    "org_id" : 0,
    "name" : "VLAN_profile_0",
    "default_vlan_id" : 0,
    "enable_classification" : false,
    "classified_entries" : [ {
      "id" : 0,
      "create_time" : "1970-01-01T00:00:00.000+0000",
      "update_time" : "1970-01-01T00:00:00.000+0000",
      "org_id" : 0,
      "vlan_id" : 0,
      "classification_rule" : {
        "id" : 1,
        "create_time" : "2024-04-03T19:55:24.000+0000",
        "update_time" : "2024-04-03T19:55:24.000+0000",
        "org_id" : 0,
        "name" : "10.0.0.1",
        "description" : "IP classification assignment",
        "classifications" : [ {
          "id" : 0,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        }, {
          "id" : 1,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        }, {
          "id" : 2,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        } ]
      }
    }, {
      "id" : 1,
      "create_time" : "1970-01-01T00:00:00.000+0000",
      "update_time" : "1970-01-01T00:00:00.000+0000",
      "org_id" : 0,
      "vlan_id" : 1,
      "classification_rule" : {
        "id" : 1,
        "create_time" : "2024-04-03T19:55:24.000+0000",
        "update_time" : "2024-04-03T19:55:24.000+0000",
        "org_id" : 0,
        "name" : "10.0.0.1",
        "description" : "IP classification assignment",
        "classifications" : [ {
          "id" : 0,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        }, {
          "id" : 1,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        }, {
          "id" : 2,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        } ]
      }
    }, {
      "id" : 2,
      "create_time" : "1970-01-01T00:00:00.000+0000",
      "update_time" : "1970-01-01T00:00:00.000+0000",
      "org_id" : 0,
      "vlan_id" : 2,
      "classification_rule" : {
        "id" : 1,
        "create_time" : "2024-04-03T19:55:24.000+0000",
        "update_time" : "2024-04-03T19:55:24.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,
    "name" : "VLAN_profile_1",
    "default_vlan_id" : 0,
    "enable_classification" : false,
    "classified_entries" : [ {
      "id" : 0,
      "create_time" : "1970-01-01T00:00:00.000+0000",
      "update_time" : "1970-01-01T00:00:00.000+0000",
      "org_id" : 0,
      "vlan_id" : 0,
      "classification_rule" : {
        "id" : 1,
        "create_time" : "2024-04-03T19:55:24.000+0000",
        "update_time" : "2024-04-03T19:55:24.000+0000",
        "org_id" : 0,
        "name" : "10.0.0.1",
        "description" : "IP classification assignment",
        "classifications" : [ {
          "id" : 0,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        }, {
          "id" : 1,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        }, {
          "id" : 2,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        } ]
      }
    }, {
      "id" : 1,
      "create_time" : "1970-01-01T00:00:00.000+0000",
      "update_time" : "1970-01-01T00:00:00.000+0000",
      "org_id" : 0,
      "vlan_id" : 1,
      "classification_rule" : {
        "id" : 1,
        "create_time" : "2024-04-03T19:55:24.000+0000",
        "update_time" : "2024-04-03T19:55:24.000+0000",
        "org_id" : 0,
        "name" : "10.0.0.1",
        "description" : "IP classification assignment",
        "classifications" : [ {
          "id" : 0,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        }, {
          "id" : 1,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        }, {
          "id" : 2,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        } ]
      }
    }, {
      "id" : 2,
      "create_time" : "1970-01-01T00:00:00.000+0000",
      "update_time" : "1970-01-01T00:00:00.000+0000",
      "org_id" : 0,
      "vlan_id" : 2,
      "classification_rule" : {
        "id" : 1,
        "create_time" : "2024-04-03T19:55:24.000+0000",
        "update_time" : "2024-04-03T19:55:24.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,
    "name" : "VLAN_profile_2",
    "default_vlan_id" : 0,
    "enable_classification" : false,
    "classified_entries" : [ {
      "id" : 0,
      "create_time" : "1970-01-01T00:00:00.000+0000",
      "update_time" : "1970-01-01T00:00:00.000+0000",
      "org_id" : 0,
      "vlan_id" : 0,
      "classification_rule" : {
        "id" : 1,
        "create_time" : "2024-04-03T19:55:24.000+0000",
        "update_time" : "2024-04-03T19:55:24.000+0000",
        "org_id" : 0,
        "name" : "10.0.0.1",
        "description" : "IP classification assignment",
        "classifications" : [ {
          "id" : 0,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        }, {
          "id" : 1,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        }, {
          "id" : 2,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        } ]
      }
    }, {
      "id" : 1,
      "create_time" : "1970-01-01T00:00:00.000+0000",
      "update_time" : "1970-01-01T00:00:00.000+0000",
      "org_id" : 0,
      "vlan_id" : 1,
      "classification_rule" : {
        "id" : 1,
        "create_time" : "2024-04-03T19:55:24.000+0000",
        "update_time" : "2024-04-03T19:55:24.000+0000",
        "org_id" : 0,
        "name" : "10.0.0.1",
        "description" : "IP classification assignment",
        "classifications" : [ {
          "id" : 0,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        }, {
          "id" : 1,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        }, {
          "id" : 2,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        } ]
      }
    }, {
      "id" : 2,
      "create_time" : "1970-01-01T00:00:00.000+0000",
      "update_time" : "1970-01-01T00:00:00.000+0000",
      "org_id" : 0,
      "vlan_id" : 2,
      "classification_rule" : {
        "id" : 1,
        "create_time" : "2024-04-03T19:55:24.000+0000",
        "update_time" : "2024-04-03T19:55:24.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/vlan-profiles?page=1&limit=10' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNCwiZXhwIjoxNzEyNzc4OTI0fQ.T0Vfd2v4NVXRKrv9Jc93gl5VztjKcLQpN6EqDDMKIyU'

Create VLAN profile

POST /vlan-profiles

Request Fields

Path Type Description

name

String

The vlan profile name

default_vlan_id

Number

The default vlan id

enable_classification

Boolean

Whether or not apply VLANs to devices using classification

classified_entries[].vlan_id

Number

The VLAN ID

classified_entries[].classification_rule_id

Number

The classification assignment ID

HTTP Request

POST /vlan-profiles HTTP/1.1
Host: api.extremecloudiq.com
Content-Length: 297
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNCwiZXhwIjoxNzEyNzc4OTI0fQ.T0Vfd2v4NVXRKrv9Jc93gl5VztjKcLQpN6EqDDMKIyU

{
  "name" : "test-co-vlan-01",
  "default_vlan_id" : 1,
  "enable_classification" : true,
  "classified_entries" : [ {
    "vlan_id" : 1,
    "classification_rule_id" : 2
  }, {
    "vlan_id" : 1,
    "classification_rule_id" : 2
  }, {
    "vlan_id" : 1,
    "classification_rule_id" : 2
  } ]
}

Response Fields

Path Type Description

id

Number

The vlan profile ID

org_id

Number

The profile’s org id

name

String

The vlan profile name

create_time

String

The create time of vlan profile

update_time

String

The update time of vlan profile

default_vlan_id

Number

The default vlan ID

enable_classification

Boolean

The enable classification name

classified_entries[].id

Number

The classified entry ID

classified_entries[].create_time

String

The create time

classified_entries[].update_time

String

The update time

classified_entries[].vlan_id

Number

The vlan ID

classified_entries[].org_id

Number

The vlan org ID

classified_entries[].classification_rule.id

Number

The classification assignment ID

classified_entries[].classification_rule.org_id

Number

The classification assignment org ID

classified_entries[].classification_rule.name

String

The classification assignment name

classified_entries[].classification_rule.description

String

The classification assignment description

classified_entries[].classification_rule.create_time

String

The create time of classification assignment

classified_entries[].classification_rule.update_time

String

The update time of classification assignment

classified_entries[].classification_rule.classifications[].id

Number

The classification ID

classified_entries[].classification_rule.classifications[].match

Boolean

The match type of classification

classified_entries[].classification_rule.classifications[].value

String

The value of classification

classified_entries[].classification_rule.classifications[].create_time

String

The create time of classification

classified_entries[].classification_rule.classifications[].update_time

String

The update time of classification

classified_entries[].classification_rule.classifications[].classification_type

String

The classification type

classified_entries[].classification_rule.classifications[].classification_id

Number

The classification reference ID

HTTP Response

HTTP/1.1 201 Created
Pragma: no-cache
Content-Length: 4060
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
RateLimit-Remaining: 7428
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",
  "org_id" : 0,
  "name" : "VLAN_profile_",
  "default_vlan_id" : 0,
  "enable_classification" : false,
  "classified_entries" : [ {
    "id" : 0,
    "create_time" : "1970-01-01T00:00:00.000+0000",
    "update_time" : "1970-01-01T00:00:00.000+0000",
    "org_id" : 0,
    "vlan_id" : 0,
    "classification_rule" : {
      "id" : 1,
      "create_time" : "2024-04-03T19:55:24.000+0000",
      "update_time" : "2024-04-03T19:55:24.000+0000",
      "org_id" : 0,
      "name" : "10.0.0.1",
      "description" : "IP classification assignment",
      "classifications" : [ {
        "id" : 0,
        "create_time" : "1970-01-01T00:00:00.000+0000",
        "update_time" : "1970-01-01T00:00:00.000+0000",
        "classification_type" : "IP_ADDRESS",
        "match" : true,
        "classification_id" : 1,
        "value" : "10.0.0.1"
      }, {
        "id" : 1,
        "create_time" : "1970-01-01T00:00:00.000+0000",
        "update_time" : "1970-01-01T00:00:00.000+0000",
        "classification_type" : "IP_ADDRESS",
        "match" : true,
        "classification_id" : 1,
        "value" : "10.0.0.1"
      }, {
        "id" : 2,
        "create_time" : "1970-01-01T00:00:00.000+0000",
        "update_time" : "1970-01-01T00:00:00.000+0000",
        "classification_type" : "IP_ADDRESS",
        "match" : true,
        "classification_id" : 1,
        "value" : "10.0.0.1"
      } ]
    }
  }, {
    "id" : 1,
    "create_time" : "1970-01-01T00:00:00.000+0000",
    "update_time" : "1970-01-01T00:00:00.000+0000",
    "org_id" : 0,
    "vlan_id" : 1,
    "classification_rule" : {
      "id" : 1,
      "create_time" : "2024-04-03T19:55:24.000+0000",
      "update_time" : "2024-04-03T19:55:24.000+0000",
      "org_id" : 0,
      "name" : "10.0.0.1",
      "description" : "IP classification assignment",
      "classifications" : [ {
        "id" : 0,
        "create_time" : "1970-01-01T00:00:00.000+0000",
        "update_time" : "1970-01-01T00:00:00.000+0000",
        "classification_type" : "IP_ADDRESS",
        "match" : true,
        "classification_id" : 1,
        "value" : "10.0.0.1"
      }, {
        "id" : 1,
        "create_time" : "1970-01-01T00:00:00.000+0000",
        "update_time" : "1970-01-01T00:00:00.000+0000",
        "classification_type" : "IP_ADDRESS",
        "match" : true,
        "classification_id" : 1,
        "value" : "10.0.0.1"
      }, {
        "id" : 2,
        "create_time" : "1970-01-01T00:00:00.000+0000",
        "update_time" : "1970-01-01T00:00:00.000+0000",
        "classification_type" : "IP_ADDRESS",
        "match" : true,
        "classification_id" : 1,
        "value" : "10.0.0.1"
      } ]
    }
  }, {
    "id" : 2,
    "create_time" : "1970-01-01T00:00:00.000+0000",
    "update_time" : "1970-01-01T00:00:00.000+0000",
    "org_id" : 0,
    "vlan_id" : 2,
    "classification_rule" : {
      "id" : 1,
      "create_time" : "2024-04-03T19:55:24.000+0000",
      "update_time" : "2024-04-03T19:55:24.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/vlan-profiles' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNCwiZXhwIjoxNzEyNzc4OTI0fQ.T0Vfd2v4NVXRKrv9Jc93gl5VztjKcLQpN6EqDDMKIyU' \
    -d '{
  "name" : "test-co-vlan-01",
  "default_vlan_id" : 1,
  "enable_classification" : true,
  "classified_entries" : [ {
    "vlan_id" : 1,
    "classification_rule_id" : 2
  }, {
    "vlan_id" : 1,
    "classification_rule_id" : 2
  }, {
    "vlan_id" : 1,
    "classification_rule_id" : 2
  } ]
}'

Get VLAN profile

GET /vlan-profiles/{id}

Path parameters

Table 77. /vlan-profiles/{id}
Parameter	Description
`id`	The vlan profile ID

HTTP Request

GET /vlan-profiles/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNCwiZXhwIjoxNzEyNzc4OTI0fQ.T0Vfd2v4NVXRKrv9Jc93gl5VztjKcLQpN6EqDDMKIyU

Response Fields

Path Type Description

id

Number

The vlan profile ID.

org_id

Number

The profile’s org ID.

create_time

String

The create time.

update_time

String

The last update time.

name

String

The vlan profile name

default_vlan_id

Number

The default vlan ID.

enable_classification

Boolean

Enable classification.

classified_entries[].id

Number

The classification entry id.

classified_entries[].org_id

Number

The classification entry org id.

classified_entries[].create_time

String

The create time of classified entry.

classified_entries[].update_time

String

The update time of classified entry.

classified_entries[].vlan_id

Number

The vlan ID.

classified_entries[].classification_rule.id

Number

The classification assignment ID.

classified_entries[].classification_rule.org_id

Number

The classification assignment org ID.

classified_entries[].classification_rule.name

String

The classification assignment name.

classified_entries[].classification_rule.description

String

The classification assignment description.

classified_entries[].classification_rule.create_time

String

The create time of classification assignment.

classified_entries[].classification_rule.update_time

String

The update time of classification assignment.

classified_entries[].classification_rule.classifications[].id

Number

The classification ID.

classified_entries[].classification_rule.classifications[].match

Boolean

Match or not match with classifications.

classified_entries[].classification_rule.classifications[].value

String

The value of classification.

classified_entries[].classification_rule.classifications[].create_time

String

The create time of classification.

classified_entries[].classification_rule.classifications[].update_time

String

The update time of classification.

classified_entries[].classification_rule.classifications[].classification_type

String

The classification type.

classified_entries[].classification_rule.classifications[].classification_id

Number

The classification reference ID.

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
Content-Length: 4060
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
RateLimit-Remaining: 7426
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",
  "org_id" : 0,
  "name" : "VLAN_profile_",
  "default_vlan_id" : 0,
  "enable_classification" : false,
  "classified_entries" : [ {
    "id" : 0,
    "create_time" : "1970-01-01T00:00:00.000+0000",
    "update_time" : "1970-01-01T00:00:00.000+0000",
    "org_id" : 0,
    "vlan_id" : 0,
    "classification_rule" : {
      "id" : 1,
      "create_time" : "2024-04-03T19:55:24.000+0000",
      "update_time" : "2024-04-03T19:55:24.000+0000",
      "org_id" : 0,
      "name" : "10.0.0.1",
      "description" : "IP classification assignment",
      "classifications" : [ {
        "id" : 0,
        "create_time" : "1970-01-01T00:00:00.000+0000",
        "update_time" : "1970-01-01T00:00:00.000+0000",
        "classification_type" : "IP_ADDRESS",
        "match" : true,
        "classification_id" : 1,
        "value" : "10.0.0.1"
      }, {
        "id" : 1,
        "create_time" : "1970-01-01T00:00:00.000+0000",
        "update_time" : "1970-01-01T00:00:00.000+0000",
        "classification_type" : "IP_ADDRESS",
        "match" : true,
        "classification_id" : 1,
        "value" : "10.0.0.1"
      }, {
        "id" : 2,
        "create_time" : "1970-01-01T00:00:00.000+0000",
        "update_time" : "1970-01-01T00:00:00.000+0000",
        "classification_type" : "IP_ADDRESS",
        "match" : true,
        "classification_id" : 1,
        "value" : "10.0.0.1"
      } ]
    }
  }, {
    "id" : 1,
    "create_time" : "1970-01-01T00:00:00.000+0000",
    "update_time" : "1970-01-01T00:00:00.000+0000",
    "org_id" : 0,
    "vlan_id" : 1,
    "classification_rule" : {
      "id" : 1,
      "create_time" : "2024-04-03T19:55:24.000+0000",
      "update_time" : "2024-04-03T19:55:24.000+0000",
      "org_id" : 0,
      "name" : "10.0.0.1",
      "description" : "IP classification assignment",
      "classifications" : [ {
        "id" : 0,
        "create_time" : "1970-01-01T00:00:00.000+0000",
        "update_time" : "1970-01-01T00:00:00.000+0000",
        "classification_type" : "IP_ADDRESS",
        "match" : true,
        "classification_id" : 1,
        "value" : "10.0.0.1"
      }, {
        "id" : 1,
        "create_time" : "1970-01-01T00:00:00.000+0000",
        "update_time" : "1970-01-01T00:00:00.000+0000",
        "classification_type" : "IP_ADDRESS",
        "match" : true,
        "classification_id" : 1,
        "value" : "10.0.0.1"
      }, {
        "id" : 2,
        "create_time" : "1970-01-01T00:00:00.000+0000",
        "update_time" : "1970-01-01T00:00:00.000+0000",
        "classification_type" : "IP_ADDRESS",
        "match" : true,
        "classification_id" : 1,
        "value" : "10.0.0.1"
      } ]
    }
  }, {
    "id" : 2,
    "create_time" : "1970-01-01T00:00:00.000+0000",
    "update_time" : "1970-01-01T00:00:00.000+0000",
    "org_id" : 0,
    "vlan_id" : 2,
    "classification_rule" : {
      "id" : 1,
      "create_time" : "2024-04-03T19:55:24.000+0000",
      "update_time" : "2024-04-03T19:55:24.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/vlan-profiles/438086664193' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNCwiZXhwIjoxNzEyNzc4OTI0fQ.T0Vfd2v4NVXRKrv9Jc93gl5VztjKcLQpN6EqDDMKIyU'

Delete VLAN profile

DELETE /vlan-profiles/{id}

Path Parameters

Table 78. /vlan-profiles/{id}
Parameter	Description
`id`	The vlan profile ID

HTTP Request

DELETE /vlan-profiles/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNCwiZXhwIjoxNzEyNzc4OTI0fQ.T0Vfd2v4NVXRKrv9Jc93gl5VztjKcLQpN6EqDDMKIyU

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: 7427
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/vlan-profiles/438086664193' -i -X DELETE \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNCwiZXhwIjoxNzEyNzc4OTI0fQ.T0Vfd2v4NVXRKrv9Jc93gl5VztjKcLQpN6EqDDMKIyU'

Update VLAN profile

PATCH /vlan-profiles/{id}

Path Parameters

Table 79. /vlan-profiles/{id}
Parameter	Description
`id`	The vlan profile ID

Request Fields

Path Type Description

name

String

The vlan profile name

default_vlan_id

Number

The default vlan id

enable_classification

Boolean

Whether or not apply VLANs to devices using classification

classified_entries[].vlan_id

Number

The VLAN ID

classified_entries[].classification_rule_id

Number

The classification assignment ID

HTTP Request

PATCH /vlan-profiles/438086664193 HTTP/1.1
Content-Length: 295
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNCwiZXhwIjoxNzEyNzc4OTI0fQ.T0Vfd2v4NVXRKrv9Jc93gl5VztjKcLQpN6EqDDMKIyU

{
  "name" : "test-co-ca-01",
  "default_vlan_id" : 1,
  "enable_classification" : true,
  "classified_entries" : [ {
    "vlan_id" : 1,
    "classification_rule_id" : 1
  }, {
    "vlan_id" : 1,
    "classification_rule_id" : 1
  }, {
    "vlan_id" : 1,
    "classification_rule_id" : 1
  } ]
}

Response Fields

Path Type Description

id

Number

The vlan profile ID

org_id

Number

The profile’s org ID

name

String

The vlan profile name

create_time

String

The create time of vlan profile

update_time

String

The update time of vlan profile

default_vlan_id

Number

The default vlan ID

enable_classification

Boolean

The enable classification name

classified_entries[].id

Number

The classified entry ID

classified_entries[].org_id

Number

The classified entry org ID

classified_entries[].create_time

String

The create time

classified_entries[].update_time

String

The update time

classified_entries[].vlan_id

Number

The vlan ID

classified_entries[].classification_rule.id

Number

The classification assignment ID

classified_entries[].classification_rule.org_id

Number

The classification assignment org ID

classified_entries[].classification_rule.name

String

The classification assignment name

classified_entries[].classification_rule.description

String

The classification assignment description

classified_entries[].classification_rule.create_time

String

The create time of classification assignment

classified_entries[].classification_rule.update_time

String

The update time of classification assignment

classified_entries[].classification_rule.classifications[].id

Number

The classification ID

classified_entries[].classification_rule.classifications[].match

Boolean

The match type of classification

classified_entries[].classification_rule.classifications[].value

String

The value of classification

classified_entries[].classification_rule.classifications[].create_time

String

The create time of classification

classified_entries[].classification_rule.classifications[].update_time

String

The update time of classification

classified_entries[].classification_rule.classifications[].classification_type

String

The classification type

classified_entries[].classification_rule.classifications[].classification_id

Number

The classification reference ID

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
Content-Length: 4060
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
RateLimit-Remaining: 7425
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",
  "org_id" : 0,
  "name" : "VLAN_profile_",
  "default_vlan_id" : 0,
  "enable_classification" : false,
  "classified_entries" : [ {
    "id" : 0,
    "create_time" : "1970-01-01T00:00:00.000+0000",
    "update_time" : "1970-01-01T00:00:00.000+0000",
    "org_id" : 0,
    "vlan_id" : 0,
    "classification_rule" : {
      "id" : 1,
      "create_time" : "2024-04-03T19:55:24.000+0000",
      "update_time" : "2024-04-03T19:55:24.000+0000",
      "org_id" : 0,
      "name" : "10.0.0.1",
      "description" : "IP classification assignment",
      "classifications" : [ {
        "id" : 0,
        "create_time" : "1970-01-01T00:00:00.000+0000",
        "update_time" : "1970-01-01T00:00:00.000+0000",
        "classification_type" : "IP_ADDRESS",
        "match" : true,
        "classification_id" : 1,
        "value" : "10.0.0.1"
      }, {
        "id" : 1,
        "create_time" : "1970-01-01T00:00:00.000+0000",
        "update_time" : "1970-01-01T00:00:00.000+0000",
        "classification_type" : "IP_ADDRESS",
        "match" : true,
        "classification_id" : 1,
        "value" : "10.0.0.1"
      }, {
        "id" : 2,
        "create_time" : "1970-01-01T00:00:00.000+0000",
        "update_time" : "1970-01-01T00:00:00.000+0000",
        "classification_type" : "IP_ADDRESS",
        "match" : true,
        "classification_id" : 1,
        "value" : "10.0.0.1"
      } ]
    }
  }, {
    "id" : 1,
    "create_time" : "1970-01-01T00:00:00.000+0000",
    "update_time" : "1970-01-01T00:00:00.000+0000",
    "org_id" : 0,
    "vlan_id" : 1,
    "classification_rule" : {
      "id" : 1,
      "create_time" : "2024-04-03T19:55:24.000+0000",
      "update_time" : "2024-04-03T19:55:24.000+0000",
      "org_id" : 0,
      "name" : "10.0.0.1",
      "description" : "IP classification assignment",
      "classifications" : [ {
        "id" : 0,
        "create_time" : "1970-01-01T00:00:00.000+0000",
        "update_time" : "1970-01-01T00:00:00.000+0000",
        "classification_type" : "IP_ADDRESS",
        "match" : true,
        "classification_id" : 1,
        "value" : "10.0.0.1"
      }, {
        "id" : 1,
        "create_time" : "1970-01-01T00:00:00.000+0000",
        "update_time" : "1970-01-01T00:00:00.000+0000",
        "classification_type" : "IP_ADDRESS",
        "match" : true,
        "classification_id" : 1,
        "value" : "10.0.0.1"
      }, {
        "id" : 2,
        "create_time" : "1970-01-01T00:00:00.000+0000",
        "update_time" : "1970-01-01T00:00:00.000+0000",
        "classification_type" : "IP_ADDRESS",
        "match" : true,
        "classification_id" : 1,
        "value" : "10.0.0.1"
      } ]
    }
  }, {
    "id" : 2,
    "create_time" : "1970-01-01T00:00:00.000+0000",
    "update_time" : "1970-01-01T00:00:00.000+0000",
    "org_id" : 0,
    "vlan_id" : 2,
    "classification_rule" : {
      "id" : 1,
      "create_time" : "2024-04-03T19:55:24.000+0000",
      "update_time" : "2024-04-03T19:55:24.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/vlan-profiles/438086664193' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNCwiZXhwIjoxNzEyNzc4OTI0fQ.T0Vfd2v4NVXRKrv9Jc93gl5VztjKcLQpN6EqDDMKIyU' \
    -d '{
  "name" : "test-co-ca-01",
  "default_vlan_id" : 1,
  "enable_classification" : true,
  "classified_entries" : [ {
    "vlan_id" : 1,
    "classification_rule_id" : 1
  }, {
    "vlan_id" : 1,
    "classification_rule_id" : 1
  }, {
    "vlan_id" : 1,
    "classification_rule_id" : 1
  } ]
}'

Configuration - User Management

List Email templates

GET /email-templates

Request Parameters

Parameter Description

password_type

The password type for filtering email templates

HTTP Request

GET /email-templates HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyOCwiZXhwIjoxNzEyNzc4OTI4fQ.CKRAbCrx4Z4c_k6cOoDlIGFV6clh_h8XX07vmSXRtps
Content-Type: application/json

Response Fields

Path Type Description

[].id

Number

The email template ID

[].create_time

String

The create time

[].update_time

String

The last update time

[].org_id

Number

The organization identifier, valid when enabling HIQ feature

[].name

String

The name of email template

[].description

String

The description of email template

[].predefined

Boolean

Flag to describe whether the email template is predefined

[].content

String

The content of email template

[].password_type

String

The password type of email template

[].enable_preview

Boolean

Flag to enable preview for email template

[].logo_url

String

The logo url of email template

[].icon_url

String

The icon url of email template

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
RateLimit-Remaining: 7399
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: 1139

[ {
  "id" : 1,
  "create_time" : "2024-04-03T19:55:28.000+0000",
  "update_time" : "2024-04-03T19:55:28.000+0000",
  "org_id" : 0,
  "name" : "test-template-1",
  "description" : "test-template-1",
  "predefined" : false,
  "content" : "test content",
  "enable_preview" : false,
  "logo_url" : "this is logo url",
  "icon_url" : "this is icon url",
  "password_type" : "PPSK"
}, {
  "id" : 2,
  "create_time" : "2024-04-03T19:55:28.000+0000",
  "update_time" : "2024-04-03T19:55:28.000+0000",
  "org_id" : 0,
  "name" : "test-template-2",
  "description" : "test-template-2",
  "predefined" : false,
  "content" : "test content",
  "enable_preview" : false,
  "logo_url" : "this is logo url",
  "icon_url" : "this is icon url",
  "password_type" : "PPSK"
}, {
  "id" : 3,
  "create_time" : "2024-04-03T19:55:28.000+0000",
  "update_time" : "2024-04-03T19:55:28.000+0000",
  "org_id" : 0,
  "name" : "test-template-3",
  "description" : "test-template-3",
  "predefined" : false,
  "content" : "test content",
  "enable_preview" : false,
  "logo_url" : "this is logo url",
  "icon_url" : "this is icon url",
  "password_type" : "PPSK"
} ]

cURL Request

$ curl 'https://api.extremecloudiq.com/email-templates' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyOCwiZXhwIjoxNzEyNzc4OTI4fQ.CKRAbCrx4Z4c_k6cOoDlIGFV6clh_h8XX07vmSXRtps' \
    -H 'Content-Type: application/json'

List end users

GET /endusers

Request Parameters

Parameter Description

page

Page number

limit

Page size

user_group_ids

The user group IDs

usernames

The list of username

HTTP Request

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

Response Fields

Path Type Description

page

Number

The current page number

count

Number

The element count of the current page

total_pages

Number

The total page number based on request page size

total_count

Number

The total element count

data[].id

Number

The user ID

data[].create_time

String

The create time

data[].update_time

String

The last update time

data[].org_id

Number

The organization identifier, valid when enabling HIQ feature

data[].name

String

The name of user

data[].user_name

String

The user identifiable name or the same one from common name, emailAddress or phoneNumber

data[].description

String

The description of user

data[].organization

String

The organization of user

data[].visit_purpose

String

The visit purpose of user

data[].email_address

String

The email address of user

data[].phone_number

String

The phone number of user

data[].password

String

The password of user

data[].email_password_delivery

String

The email password delivery of user

data[].sms_password_delivery

String

The SMS password delivery of user

data[].user_group_id

Number

The group ID of user

data[].user_group_name

String

The user group name

data[].approval_type

String

The approval type

data[].expired_time

Number

The password expired time

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Content-Length: 1329
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: 7384

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 1,
  "total_count" : 2,
  "data" : [ {
    "id" : 1,
    "create_time" : "2024-04-03T19:55:29.000+0000",
    "update_time" : "2024-04-03T19:55:29.000+0000",
    "org_id" : 0,
    "name" : "test-user-1",
    "description" : "this is test user1",
    "email_address" : "test1@google.com",
    "phone_number" : "123456789",
    "password" : "***",
    "user_name" : "test-user-1",
    "organization" : "DEFAULT",
    "visit_purpose" : "GUEST",
    "email_password_delivery" : "",
    "sms_password_delivery" : "123456789",
    "user_group_id" : 1,
    "user_group_name" : "TEST-USER-GROUP-1",
    "approval_type" : "NO_APPROVAL",
    "expired_time" : 300
  }, {
    "id" : 2,
    "create_time" : "2024-04-03T19:55:29.000+0000",
    "update_time" : "2024-04-03T19:55:29.000+0000",
    "org_id" : 0,
    "name" : "test-user-2",
    "description" : "this is test user2",
    "email_address" : "test2@google.com",
    "phone_number" : "123456789",
    "password" : "***",
    "user_name" : "test-user-2",
    "organization" : "DEFAULT",
    "visit_purpose" : "GUEST",
    "email_password_delivery" : "",
    "sms_password_delivery" : "123456789",
    "user_group_id" : 1,
    "user_group_name" : "TEST-USER-GROUP-2",
    "approval_type" : "NO_APPROVAL",
    "expired_time" : 300
  } ]
}

cURL Request

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

Create end user

POST /endusers

Request Fields

Path Type Description

user_name

String

The designated username the same as the common name, emailAddress, or phoneNumber

name

String

The name of user

description

String

The description of user

organization

String

The organization of user

visit_purpose

String

The visit purpose of user

email_address

String

The email address of user

phone_number

String

The phone number of user

password

String

The user password of user

email_password_delivery

String

The email password delivery of user

sms_password_delivery

String

The SMS password delivery of user

user_group_id

Number

The group ID of user

HTTP Request

POST /endusers HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Content-Length: 316
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyOSwiZXhwIjoxNzEyNzc4OTI5fQ.yzcRp_ZaypyTMPkxRe4ww9vCd2cFw6UJJjsng9vGJ8c

{
  "user_group_id" : 1,
  "name" : "test-user-1",
  "user_name" : "test-user-1",
  "organization" : "DEFAULT",
  "visit_purpose" : "GUEST",
  "description" : "this is test user1",
  "email_address" : "test1@google.com",
  "phone_number" : "123456789",
  "password" : "***",
  "sms_password_delivery" : "123456789"
}

Response Fields

Path Type Description

id

Number

The user ID

create_time

String

The create time

update_time

String

The last update time

org_id

Number

The organization identifier, valid when enabling HIQ feature

name

String

The name of user

user_name

String

The user identifiable name or the same one from common name, emailAddress or phoneNumber

description

String

The description of user

organization

String

The organization of user

visit_purpose

String

The visit purpose of user

email_address

String

The email address of user

phone_number

String

The phone number of user

password

String

The password of user

email_password_delivery

String

The email password delivery of user

sms_password_delivery

String

The SMS password delivery of user

user_group_id

Number

The group ID of user

user_group_name

String

The user group name

approval_type

String

The approval type

expired_time

Number

The password expired time

HTTP Response

HTTP/1.1 200 OK
Content-Length: 580
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: 7382

{
  "id" : 1,
  "create_time" : "2024-04-03T19:55:29.000+0000",
  "update_time" : "2024-04-03T19:55:29.000+0000",
  "org_id" : 0,
  "name" : "test-user-1",
  "description" : "this is test user1",
  "email_address" : "test1@google.com",
  "phone_number" : "123456789",
  "password" : "***",
  "user_name" : "test-user-1",
  "organization" : "DEFAULT",
  "visit_purpose" : "GUEST",
  "email_password_delivery" : "",
  "sms_password_delivery" : "123456789",
  "user_group_id" : 1,
  "user_group_name" : "TEST-USER-GROUP-1",
  "approval_type" : "NO_APPROVAL",
  "expired_time" : 300
}

cURL Request

$ curl 'https://api.extremecloudiq.com/endusers' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyOSwiZXhwIjoxNzEyNzc4OTI5fQ.yzcRp_ZaypyTMPkxRe4ww9vCd2cFw6UJJjsng9vGJ8c' \
    -d '{
  "user_group_id" : 1,
  "name" : "test-user-1",
  "user_name" : "test-user-1",
  "organization" : "DEFAULT",
  "visit_purpose" : "GUEST",
  "description" : "this is test user1",
  "email_address" : "test1@google.com",
  "phone_number" : "123456789",
  "password" : "***",
  "sms_password_delivery" : "123456789"
}'

Update end user

PUT /endusers/{id}

Path Parameters

Table 80. /endusers/{id}
Parameter	Description
`id`	The user ID

Request Fields

Path Type Description

name

String

The name of user

description

String

The description of user

organization

String

The organization of user

visit_purpose

String

The visit purpose of user

email_address

String

The email address of user

phone_number

String

The phone number of user

password

String

The user password of user

email_password_delivery

String

The email password delivery of user

sms_password_delivery

String

The SMS password delivery of user

HTTP Request

PUT /endusers/438086664193 HTTP/1.1
Content-Length: 262
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyOSwiZXhwIjoxNzEyNzc4OTI5fQ.yzcRp_ZaypyTMPkxRe4ww9vCd2cFw6UJJjsng9vGJ8c

{
  "name" : "test-user-1",
  "organization" : "DEFAULT",
  "visit_purpose" : "GUEST",
  "description" : "this is test user1",
  "email_address" : "test1@google.com",
  "phone_number" : "123456789",
  "password" : "***",
  "sms_password_delivery" : "123456789"
}

Response Fields

Path Type Description

id

Number

The user ID

create_time

String

The create time

update_time

String

The last update time

org_id

Number

The organization identifier, valid when enabling HIQ feature

name

String

The name of user

user_name

String

The user identifiable name or the same one from common name, emailAddress or phoneNumber

description

String

The description of user

organization

String

The organization of user

visit_purpose

String

The visit purpose of user

email_address

String

The email address of user

phone_number

String

The phone number of user

password

String

The password of user

email_password_delivery

String

The email password delivery of user

sms_password_delivery

String

The SMS password delivery of user

user_group_id

Number

The group ID of user

user_group_name

String

The user group name

approval_type

String

The approval type

expired_time

Number

The password expired time

HTTP Response

HTTP/1.1 200 OK
Content-Length: 580
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: 7383

{
  "id" : 1,
  "create_time" : "2024-04-03T19:55:29.000+0000",
  "update_time" : "2024-04-03T19:55:29.000+0000",
  "org_id" : 0,
  "name" : "test-user-1",
  "description" : "this is test user1",
  "email_address" : "test1@google.com",
  "phone_number" : "123456789",
  "password" : "***",
  "user_name" : "test-user-1",
  "organization" : "DEFAULT",
  "visit_purpose" : "GUEST",
  "email_password_delivery" : "",
  "sms_password_delivery" : "123456789",
  "user_group_id" : 1,
  "user_group_name" : "TEST-USER-GROUP-1",
  "approval_type" : "NO_APPROVAL",
  "expired_time" : 300
}

cURL Request

$ curl 'https://api.extremecloudiq.com/endusers/438086664193' -i -X PUT \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyOSwiZXhwIjoxNzEyNzc4OTI5fQ.yzcRp_ZaypyTMPkxRe4ww9vCd2cFw6UJJjsng9vGJ8c' \
    -d '{
  "name" : "test-user-1",
  "organization" : "DEFAULT",
  "visit_purpose" : "GUEST",
  "description" : "this is test user1",
  "email_address" : "test1@google.com",
  "phone_number" : "123456789",
  "password" : "***",
  "sms_password_delivery" : "123456789"
}'

Delete end user

DELETE /endusers/{id}

Path Parameters

Table 81. /endusers/{id}
Parameter	Description
`id`	The user ID

HTTP Request

DELETE /endusers/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyOSwiZXhwIjoxNzEyNzc4OTI5fQ.yzcRp_ZaypyTMPkxRe4ww9vCd2cFw6UJJjsng9vGJ8c

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/endusers/438086664193' -i -X DELETE \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyOSwiZXhwIjoxNzEyNzc4OTI5fQ.yzcRp_ZaypyTMPkxRe4ww9vCd2cFw6UJJjsng9vGJ8c'

List Key-based PCGs

GET /pcgs/key-based

HTTP Request

GET /pcgs/key-based HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyOCwiZXhwIjoxNzEyNzc4OTI4fQ.CKRAbCrx4Z4c_k6cOoDlIGFV6clh_h8XX07vmSXRtps
Content-Type: application/json

Response Fields

Path Type Description

[].id

Number

The key based PCG ID.

[].enabled

Boolean

The enable flag of key based PCG.

[].create_time

String

The create time.

[].update_time

String

The update time.

[].org_id

Number

The organization ID.

[].policy_id

Number

The policy ID.

[].policy_name

String

The policy name.

[].ssid_name

String

The SSID name.

[].users[].id

Number

The user ID.

[].users[].name

String

The user’s name.

[].users[].email

String

The user’s email.

[].users[].create_time

String

The user’s create time.

[].users[].update_time

String

The user’s update time.

[].users[].org_id

Number

The user’s organization ID.

[].users[].user_group_name

String

The user group 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: 5077
RateLimit-Remaining: 7394

[ {
  "id" : 1,
  "create_time" : "2024-04-03T19:55:28.000+0000",
  "update_time" : "2024-04-03T19:55:28.000+0000",
  "org_id" : 10,
  "policy_id" : 0,
  "policy_name" : "pcg_1",
  "ssid_name" : "ssid_1",
  "enabled" : true,
  "users" : [ {
    "name" : "pcg_user1",
    "email" : "pcg_user_1@extremecloudiq.com",
    "user_group_name" : "pcg_user_group",
    "id" : 0,
    "create_time" : "2024-04-03T19:55:28.000+0000",
    "update_time" : "2024-04-03T19:55:28.000+0000",
    "org_id" : 10
  }, {
    "name" : "pcg_user2",
    "email" : "pcg_user_2@extremecloudiq.com",
    "user_group_name" : "pcg_user_group",
    "id" : 1,
    "create_time" : "2024-04-03T19:55:28.000+0000",
    "update_time" : "2024-04-03T19:55:28.000+0000",
    "org_id" : 10
  }, {
    "name" : "pcg_user3",
    "email" : "pcg_user_3@extremecloudiq.com",
    "user_group_name" : "pcg_user_group",
    "id" : 2,
    "create_time" : "2024-04-03T19:55:28.000+0000",
    "update_time" : "2024-04-03T19:55:28.000+0000",
    "org_id" : 10
  } ]
}, {
  "id" : 2,
  "create_time" : "2024-04-03T19:55:28.000+0000",
  "update_time" : "2024-04-03T19:55:28.000+0000",
  "org_id" : 10,
  "policy_id" : 1,
  "policy_name" : "pcg_2",
  "ssid_name" : "ssid_2",
  "enabled" : true,
  "users" : [ {
    "name" : "pcg_user1",
    "email" : "pcg_user_1@extremecloudiq.com",
    "user_group_name" : "pcg_user_group",
    "id" : 0,
    "create_time" : "2024-04-03T19:55:28.000+0000",
    "update_time" : "2024-04-03T19:55:28.000+0000",
    "org_id" : 10
  }, {
    "name" : "pcg_user2",
    "email" : "pcg_user_2@extremecloudiq.com",
    "user_group_name" : "pcg_user_group",
    "id" : 1,
    "create_time" : "2024-04-03T19:55:28.000+0000",
    "update_time" : "2024-04-03T19:55:28.000+0000",
    "org_id" : 10
  }, {
    "name" : "pcg_user3",
    "email" : "pcg_user_3@extremecloudiq.com",
    "user_group_name" : "pcg_user_group",
    "id" : 2,
    "create_time" : "2024-04-03T19:55:28.000+0000",
    "update_time" : "2024-04-03T19:55:28.000+0000",
    "org_id" : 10
  } ]
}, {
  "id" : 3,
  "create_time" : "2024-04-03T19:55:28.000+0000",
  "update_time" : "2024-04-03T19:55:28.000+0000",
  "org_id" : 10,
  "policy_id" : 2,
  "policy_name" : "pcg_3",
  "ssid_name" : "ssid_3",
  "enabled" : true,
  "users" : [ {
    "name" : "pcg_user1",
    "email" : "pcg_user_1@extremecloudiq.com",
    "user_group_name" : "pcg_user_group",
    "id" : 0,
    "create_time" : "2024-04-03T19:55:28.000+0000",
    "update_time" : "2024-04-03T19:55:28.000+0000",
    "org_id" : 10
  }, {
    "name" : "pcg_user2",
    "email" : "pcg_user_2@extremecloudiq.com",
    "user_group_name" : "pcg_user_group",
    "id" : 1,
    "create_time" : "2024-04-03T19:55:28.000+0000",
    "update_time" : "2024-04-03T19:55:28.000+0000",
    "org_id" : 10
  }, {
    "name" : "pcg_user3",
    "email" : "pcg_user_3@extremecloudiq.com",
    "user_group_name" : "pcg_user_group",
    "id" : 2,
    "create_time" : "2024-04-03T19:55:28.000+0000",
    "update_time" : "2024-04-03T19:55:28.000+0000",
    "org_id" : 10
  } ]
}, {
  "id" : 4,
  "create_time" : "2024-04-03T19:55:28.000+0000",
  "update_time" : "2024-04-03T19:55:28.000+0000",
  "org_id" : 10,
  "policy_id" : 3,
  "policy_name" : "pcg_4",
  "ssid_name" : "ssid_4",
  "enabled" : true,
  "users" : [ {
    "name" : "pcg_user1",
    "email" : "pcg_user_1@extremecloudiq.com",
    "user_group_name" : "pcg_user_group",
    "id" : 0,
    "create_time" : "2024-04-03T19:55:28.000+0000",
    "update_time" : "2024-04-03T19:55:28.000+0000",
    "org_id" : 10
  }, {
    "name" : "pcg_user2",
    "email" : "pcg_user_2@extremecloudiq.com",
    "user_group_name" : "pcg_user_group",
    "id" : 1,
    "create_time" : "2024-04-03T19:55:28.000+0000",
    "update_time" : "2024-04-03T19:55:28.000+0000",
    "org_id" : 10
  }, {
    "name" : "pcg_user3",
    "email" : "pcg_user_3@extremecloudiq.com",
    "user_group_name" : "pcg_user_group",
    "id" : 2,
    "create_time" : "2024-04-03T19:55:28.000+0000",
    "update_time" : "2024-04-03T19:55:28.000+0000",
    "org_id" : 10
  } ]
}, {
  "id" : 5,
  "create_time" : "2024-04-03T19:55:28.000+0000",
  "update_time" : "2024-04-03T19:55:28.000+0000",
  "org_id" : 10,
  "policy_id" : 4,
  "policy_name" : "pcg_5",
  "ssid_name" : "ssid_5",
  "enabled" : true,
  "users" : [ {
    "name" : "pcg_user1",
    "email" : "pcg_user_1@extremecloudiq.com",
    "user_group_name" : "pcg_user_group",
    "id" : 0,
    "create_time" : "2024-04-03T19:55:28.000+0000",
    "update_time" : "2024-04-03T19:55:28.000+0000",
    "org_id" : 10
  }, {
    "name" : "pcg_user2",
    "email" : "pcg_user_2@extremecloudiq.com",
    "user_group_name" : "pcg_user_group",
    "id" : 1,
    "create_time" : "2024-04-03T19:55:28.000+0000",
    "update_time" : "2024-04-03T19:55:28.000+0000",
    "org_id" : 10
  }, {
    "name" : "pcg_user3",
    "email" : "pcg_user_3@extremecloudiq.com",
    "user_group_name" : "pcg_user_group",
    "id" : 2,
    "create_time" : "2024-04-03T19:55:28.000+0000",
    "update_time" : "2024-04-03T19:55:28.000+0000",
    "org_id" : 10
  } ]
} ]

cURL Request

$ curl 'https://api.extremecloudiq.com/pcgs/key-based' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyOCwiZXhwIjoxNzEyNzc4OTI4fQ.CKRAbCrx4Z4c_k6cOoDlIGFV6clh_h8XX07vmSXRtps' \
    -H 'Content-Type: application/json'

Initiate Key-based PCG

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

POST /pcgs/key-based

Request Fields

Path Type Description

policy_name

String

The network policy name.

ssid_name

String

The SSID name

users

Array

The key based PCG users

users[].name

String

The user name

users[].email

String

The user email to deliver password

users[].user_group_name

String

The key based PCG user group name

HTTP Request

POST /pcgs/key-based HTTP/1.1
Host: api.extremecloudiq.com
Content-Length: 190
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyOSwiZXhwIjoxNzEyNzc4OTI5fQ.yzcRp_ZaypyTMPkxRe4ww9vCd2cFw6UJJjsng9vGJ8c
Content-Type: application/json
Content-Type: application/json

{
  "policy_name" : "PCG_policy",
  "ssid_name" : "PCG_wifi",
  "users" : [ {
    "name" : "candy",
    "email" : "candy@extremecloudiq.com",
    "user_group_name" : "room-201-group"
  } ]
}

HTTP Response

HTTP/1.1 202 Accepted
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
RateLimit-Remaining: 7388
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/pcgs/key-based' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyOSwiZXhwIjoxNzEyNzc4OTI5fQ.yzcRp_ZaypyTMPkxRe4ww9vCd2cFw6UJJjsng9vGJ8c' \
    -H 'Content-Type: application/json' \
    -H 'Content-Type: application/json' \
    -d '{
  "policy_name" : "PCG_policy",
  "ssid_name" : "PCG_wifi",
  "users" : [ {
    "name" : "candy",
    "email" : "candy@extremecloudiq.com",
    "user_group_name" : "room-201-group"
  } ]
}'

Delete Key-based PCG

Delete Key Based PCG from network policy

DELETE /pcgs/key-based/network-policy-{policyId}

Path Parameters

Table 82. /pcgs/key-based/network-policy-{policyId}
Parameter	Description
`policyId`	The network policy ID

Request Parameters

Parameter Description

ids

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

HTTP Request

DELETE /pcgs/key-based/network-policy-438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyOSwiZXhwIjoxNzEyNzc4OTI5fQ.yzcRp_ZaypyTMPkxRe4ww9vCd2cFw6UJJjsng9vGJ8c

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: 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/pcgs/key-based/network-policy-438086664193' -i -X DELETE \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyOSwiZXhwIjoxNzEyNzc4OTI5fQ.yzcRp_ZaypyTMPkxRe4ww9vCd2cFw6UJJjsng9vGJ8c'

Create Key-based PCG

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

POST /pcgs/key-based/network-policy-{policyId}/:onboard

Path Parameters

Table 83. /pcgs/key-based/network-policy-{policyId}/:onboard
Parameter	Description
`policyId`	The network policy ID

Request Fields

Path Type Description

ssid_name

String

The SSID name.

enabled

Boolean

The flag to enable/disable key based PCG

user_ids[]

Array

The user ids to enable the key based PCG

HTTP Request

POST /pcgs/key-based/network-policy-438086664193/:onboard HTTP/1.1
Host: api.extremecloudiq.com
Content-Length: 72
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyOSwiZXhwIjoxNzEyNzc4OTI5fQ.yzcRp_ZaypyTMPkxRe4ww9vCd2cFw6UJJjsng9vGJ8c
Content-Type: application/json
Content-Type: application/json

{
  "ssid_name" : "PCG_wifi",
  "enabled" : true,
  "user_ids" : [ 1 ]
}

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: 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/pcgs/key-based/network-policy-438086664193/:onboard' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyOSwiZXhwIjoxNzEyNzc4OTI5fQ.yzcRp_ZaypyTMPkxRe4ww9vCd2cFw6UJJjsng9vGJ8c' \
    -H 'Content-Type: application/json' \
    -H 'Content-Type: application/json' \
    -d '{
  "ssid_name" : "PCG_wifi",
  "enabled" : true,
  "user_ids" : [ 1 ]
}'

Email keys

Email keys for Key Based PCG users

POST /pcgs/key-based/network-policy-{policyId}/keys/:email

Path Parameters

Table 84. /pcgs/key-based/network-policy-{policyId}/keys/:email
Parameter	Description
`policyId`	The network policy ID

Request Parameters

Parameter Description

userIds

The user IDs

HTTP Request

POST /pcgs/key-based/network-policy-438086664193/keys/:email HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyOSwiZXhwIjoxNzEyNzc4OTI5fQ.yzcRp_ZaypyTMPkxRe4ww9vCd2cFw6UJJjsng9vGJ8c

userIds=438086664193&userIds=438086664194&userIds=438086664195

HTTP Response

HTTP/1.1 202 Accepted
RateLimit-Remaining: 7385
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/pcgs/key-based/network-policy-438086664193/keys/:email' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyOSwiZXhwIjoxNzEyNzc4OTI5fQ.yzcRp_ZaypyTMPkxRe4ww9vCd2cFw6UJJjsng9vGJ8c' \
    -d 'userIds=438086664193&userIds=438086664194&userIds=438086664195'

Generate keys

Generate keys for Key Based PCG users

POST /pcgs/key-based/network-policy-{policyId}/keys/:generate

Path Parameters

Table 85. /pcgs/key-based/network-policy-{policyId}/keys/:generate
Parameter	Description
`policyId`	The network policy ID

Request Parameters

Parameter Description

userIds

The user IDs

HTTP Request

POST /pcgs/key-based/network-policy-438086664193/keys/:generate HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyOSwiZXhwIjoxNzEyNzc4OTI5fQ.yzcRp_ZaypyTMPkxRe4ww9vCd2cFw6UJJjsng9vGJ8c

userIds=438086664193&userIds=438086664194&userIds=438086664195

HTTP Response

HTTP/1.1 202 Accepted
Pragma: no-cache
RateLimit-Remaining: 7387
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/pcgs/key-based/network-policy-438086664193/keys/:generate' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyOSwiZXhwIjoxNzEyNzc4OTI5fQ.yzcRp_ZaypyTMPkxRe4ww9vCd2cFw6UJJjsng9vGJ8c' \
    -d 'userIds=438086664193&userIds=438086664194&userIds=438086664195'

Get port assignments for AP150W and AP302W

GET /pcgs/key-based/network-policy-{policyId}/port-assignments

Path Parameters

Table 86. /pcgs/key-based/network-policy-{policyId}/port-assignments
Parameter	Description
`policyId`	The network policy ID

HTTP Request

GET /pcgs/key-based/network-policy-438086664193/port-assignments HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyOSwiZXhwIjoxNzEyNzc4OTI5fQ.yzcRp_ZaypyTMPkxRe4ww9vCd2cFw6UJJjsng9vGJ8c

Response Fields

Path Type Description

policy_id

Number

The network policy ID.

policy_name

String

The network policy name.

pcg_port_assignment_entry_details[]

Array

The port assignment detail entries.

pcg_port_assignment_entry_details[].id

Number

The entry ID.

pcg_port_assignment_entry_details[].org_id

Number

The organizaion ID.

pcg_port_assignment_entry_details[].create_time

String

The create time.

pcg_port_assignment_entry_details[].update_time

String

The update time.

pcg_port_assignment_entry_details[].device

Object

The AP150W or AP302W device info.

pcg_port_assignment_entry_details[].device.id

Number

The device ID.

pcg_port_assignment_entry_details[].device.org_id

Number

The organization ID.

pcg_port_assignment_entry_details[].device.create_time

String

The device create time.

pcg_port_assignment_entry_details[].device.update_time

String

The device update time.

pcg_port_assignment_entry_details[].device.mac_address

String

The device mac address.

pcg_port_assignment_entry_details[].device.serial_number

String

The device serial number.

pcg_port_assignment_entry_details[].device.product_type

String

The device product type.

pcg_port_assignment_entry_details[].eth1

Object

The eth1 meta info.

pcg_port_assignment_entry_details[].eth1.id

Number

The eth1 meta ID.

pcg_port_assignment_entry_details[].eth1.org_id

Number

The organization ID.

pcg_port_assignment_entry_details[].eth1.create_time

String

The create time.

pcg_port_assignment_entry_details[].eth1.update_time

String

The update time.

pcg_port_assignment_entry_details[].eth1.name

String

The user name.

pcg_port_assignment_entry_details[].eth1.password

String

The user password.

pcg_port_assignment_entry_details[].eth1.ssids[]

Array

The SSIDs.

pcg_port_assignment_entry_details[].eth1.user_type

String

The user type.

pcg_port_assignment_entry_details[].eth1.user_group_name

String

The user group name

pcg_port_assignment_entry_details[].eth2

Object

The eth2 meta info.

pcg_port_assignment_entry_details[].eth2.id

Number

The eth2 meta ID.

pcg_port_assignment_entry_details[].eth2.org_id

Number

The organization ID.

pcg_port_assignment_entry_details[].eth2.create_time

String

The create time.

pcg_port_assignment_entry_details[].eth2.update_time

String

The update time.

pcg_port_assignment_entry_details[].eth2.name

String

The user name.

pcg_port_assignment_entry_details[].eth2.password

String

The user password.

pcg_port_assignment_entry_details[].eth2.ssids[]

Array

The SSIDs.

pcg_port_assignment_entry_details[].eth2.user_type

String

The user type.

pcg_port_assignment_entry_details[].eth2.user_group_name

String

The user group name

pcg_port_assignment_entry_details[].eth3

Object

The eth3 meta info.

pcg_port_assignment_entry_details[].eth3.id

Number

The eth3 meta ID.

pcg_port_assignment_entry_details[].eth3.org_id

Number

The organization ID.

pcg_port_assignment_entry_details[].eth3.create_time

String

The create time.

pcg_port_assignment_entry_details[].eth3.update_time

String

The update time.

pcg_port_assignment_entry_details[].eth3.name

String

The user name.

pcg_port_assignment_entry_details[].eth3.password

String

The user password.

pcg_port_assignment_entry_details[].eth3.ssids[]

Array

The SSIDs.

pcg_port_assignment_entry_details[].eth3.user_type

String

The user type.

pcg_port_assignment_entry_details[].eth3.user_group_name

String

The user group 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-Length: 1489
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

{
  "policy_id" : 1,
  "policy_name" : "PCG_policy",
  "pcg_port_assignment_entry_details" : [ {
    "id" : 1,
    "create_time" : "2024-04-03T19:55:29.000+0000",
    "update_time" : "2024-04-03T19:55:29.000+0000",
    "org_id" : 0,
    "device" : {
      "id" : 1,
      "create_time" : "2024-04-03T19:55:29.000+0000",
      "update_time" : "2024-04-03T19:55:29.000+0000",
      "org_id" : 0,
      "mac_address" : "xxxxxxxx",
      "serial_number" : "xxx-xxx-xxx",
      "product_type" : "AP"
    },
    "eth1" : {
      "id" : 1,
      "create_time" : "2024-04-03T19:55:29.000+0000",
      "update_time" : "2024-04-03T19:55:29.000+0000",
      "org_id" : 0,
      "name" : "user_1",
      "password" : "xxxxxx",
      "user_type" : "LOCAL_PPSK",
      "user_group_name" : "pcg_user_group",
      "ssids" : [ "ssid_1" ]
    },
    "eth2" : {
      "id" : 2,
      "create_time" : "2024-04-03T19:55:29.000+0000",
      "update_time" : "2024-04-03T19:55:29.000+0000",
      "org_id" : 0,
      "name" : "user_1",
      "password" : "xxxxxx",
      "user_type" : "LOCAL_PPSK",
      "user_group_name" : "pcg_user_group",
      "ssids" : [ "ssid_2" ]
    },
    "eth3" : {
      "id" : 3,
      "create_time" : "2024-04-03T19:55:29.000+0000",
      "update_time" : "2024-04-03T19:55:29.000+0000",
      "org_id" : 0,
      "name" : "user_1",
      "password" : "xxxxxx",
      "user_type" : "LOCAL_PPSK",
      "user_group_name" : "pcg_user_group",
      "ssids" : [ "ssid_2" ]
    }
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/pcgs/key-based/network-policy-438086664193/port-assignments' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyOSwiZXhwIjoxNzEyNzc4OTI5fQ.yzcRp_ZaypyTMPkxRe4ww9vCd2cFw6UJJjsng9vGJ8c'

Assign ports for AP150W and AP302W

POST /pcgs/key-based/network-policy-{policyId}/port-assignments

Path Parameters

Table 87. /pcgs/key-based/network-policy-{policyId}/port-assignments
Parameter	Description
`policyId`	The network policy ID

Request Fields

Path Type Description

port_assignments[]

Array

The port assignment array.

port_assignments[].device_id

Number

The device ID of AP150W or AP302W

port_assignments[].eth1_user_id

Number

The user ID of eth1

port_assignments[].eth2_user_id

Number

The user ID of eth2

port_assignments[].eth3_user_id

Number

The user ID of eth3

HTTP Request

POST /pcgs/key-based/network-policy-438086664193/port-assignments HTTP/1.1
Host: api.extremecloudiq.com
Content-Length: 326
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyOSwiZXhwIjoxNzEyNzc4OTI5fQ.yzcRp_ZaypyTMPkxRe4ww9vCd2cFw6UJJjsng9vGJ8c
Content-Type: application/json
Content-Type: application/json

{
  "port_assignments" : [ {
    "device_id" : 1,
    "eth1_user_id" : 1,
    "eth2_user_id" : 2,
    "eth3_user_id" : 3
  }, {
    "device_id" : 1,
    "eth1_user_id" : 1,
    "eth2_user_id" : 2,
    "eth3_user_id" : 3
  }, {
    "device_id" : 1,
    "eth1_user_id" : 1,
    "eth2_user_id" : 2,
    "eth3_user_id" : 3
  } ]
}

Response Fields

Path Type Description

policy_id

Number

The network policy ID.

policy_name

String

The network policy name.

pcg_port_assignment_entries[].id

Number

The entry ID

pcg_port_assignment_entries[].org_id

Number

The org ID

pcg_port_assignment_entries[].create_time

String

The create time

pcg_port_assignment_entries[].update_time

String

The update time

pcg_port_assignment_entries[].device_id

Number

The device ID of AP150W or AP302W

pcg_port_assignment_entries[].eth1_user_id

Number

The user ID of eth1

pcg_port_assignment_entries[].eth2_user_id

Number

The user ID of eth2

pcg_port_assignment_entries[].eth3_user_id

Number

The user ID of eth3

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: 326
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

{
  "policy_id" : 1,
  "policy_name" : "PCG_policy",
  "pcg_port_assignment_entries" : [ {
    "id" : 1,
    "create_time" : "2024-04-03T19:55:29.000+0000",
    "update_time" : "2024-04-03T19:55:29.000+0000",
    "org_id" : 0,
    "device_id" : 1,
    "eth1_user_id" : 1,
    "eth2_user_id" : 2,
    "eth3_user_id" : 3
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/pcgs/key-based/network-policy-438086664193/port-assignments' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyOSwiZXhwIjoxNzEyNzc4OTI5fQ.yzcRp_ZaypyTMPkxRe4ww9vCd2cFw6UJJjsng9vGJ8c' \
    -H 'Content-Type: application/json' \
    -H 'Content-Type: application/json' \
    -d '{
  "port_assignments" : [ {
    "device_id" : 1,
    "eth1_user_id" : 1,
    "eth2_user_id" : 2,
    "eth3_user_id" : 3
  }, {
    "device_id" : 1,
    "eth1_user_id" : 1,
    "eth2_user_id" : 2,
    "eth3_user_id" : 3
  }, {
    "device_id" : 1,
    "eth1_user_id" : 1,
    "eth2_user_id" : 2,
    "eth3_user_id" : 3
  } ]
}'

Get Key-based PCG users for a network policy

GET /pcgs/key-based/network-policy-{policyId}/users

Path Parameters

Table 88. /pcgs/key-based/network-policy-{policyId}/users
Parameter	Description
`policyId`	The network policy ID

HTTP Request

GET /pcgs/key-based/network-policy-438086664193/users HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyOCwiZXhwIjoxNzEyNzc4OTI4fQ.CKRAbCrx4Z4c_k6cOoDlIGFV6clh_h8XX07vmSXRtps
Content-Type: application/json

Response Fields

Path Type Description

[].id

Number

The user ID.

[].name

String

The user’s name.

[].email

String

The user’s email.

[].create_time

String

The user’s create time.

[].update_time

String

The user’s update time.

[].org_id

Number

The user’s organization ID.

[].user_group_name

String

The user group name.

HTTP Response

HTTP/1.1 200 OK
Content-Length: 728
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: 7395

[ {
  "name" : "pcg_user1",
  "email" : "pcg_user_1@extremecloudiq.com",
  "user_group_name" : "pcg_user_group",
  "id" : 0,
  "create_time" : "2024-04-03T19:55:28.000+0000",
  "update_time" : "2024-04-03T19:55:28.000+0000",
  "org_id" : 10
}, {
  "name" : "pcg_user2",
  "email" : "pcg_user_2@extremecloudiq.com",
  "user_group_name" : "pcg_user_group",
  "id" : 1,
  "create_time" : "2024-04-03T19:55:28.000+0000",
  "update_time" : "2024-04-03T19:55:28.000+0000",
  "org_id" : 10
}, {
  "name" : "pcg_user3",
  "email" : "pcg_user_3@extremecloudiq.com",
  "user_group_name" : "pcg_user_group",
  "id" : 2,
  "create_time" : "2024-04-03T19:55:28.000+0000",
  "update_time" : "2024-04-03T19:55:28.000+0000",
  "org_id" : 10
} ]

cURL Request

$ curl 'https://api.extremecloudiq.com/pcgs/key-based/network-policy-438086664193/users' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyOCwiZXhwIjoxNzEyNzc4OTI4fQ.CKRAbCrx4Z4c_k6cOoDlIGFV6clh_h8XX07vmSXRtps' \
    -H 'Content-Type: application/json'

Replace Key-based PCG users

PUT /pcgs/key-based/network-policy-{policyId}/users

Path Parameters

Table 89. /pcgs/key-based/network-policy-{policyId}/users
Parameter	Description
`policyId`	The network policy ID

Request Fields

Path Type Description

users

Array

The key based PCG users

users[].name

String

The user name

users[].email

String

The user email to deliver password

users[].user_group_name

String

The key based PCG user group name

HTTP Request

PUT /pcgs/key-based/network-policy-438086664193/users HTTP/1.1
Content-Length: 130
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyOSwiZXhwIjoxNzEyNzc4OTI5fQ.yzcRp_ZaypyTMPkxRe4ww9vCd2cFw6UJJjsng9vGJ8c
Content-Type: application/json
Content-Type: application/json

{
  "users" : [ {
    "name" : "candy",
    "email" : "candy@extremecloudiq.com",
    "user_group_name" : "room-201-group"
  } ]
}

HTTP Response

HTTP/1.1 202 Accepted
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
RateLimit-Remaining: 7390
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/pcgs/key-based/network-policy-438086664193/users' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyOSwiZXhwIjoxNzEyNzc4OTI5fQ.yzcRp_ZaypyTMPkxRe4ww9vCd2cFw6UJJjsng9vGJ8c' \
    -H 'Content-Type: application/json' \
    -H 'Content-Type: application/json' \
    -d '{
  "users" : [ {
    "name" : "candy",
    "email" : "candy@extremecloudiq.com",
    "user_group_name" : "room-201-group"
  } ]
}'

Add Key-based PCG users

POST /pcgs/key-based/network-policy-{policyId}/users

Path Parameters

Table 90. /pcgs/key-based/network-policy-{policyId}/users
Parameter	Description
`policyId`	The network policy ID

Request Fields

Path Type Description

users

Array

The key based PCG users

users[].name

String

The user name

users[].email

String

The user email to deliver password

users[].user_group_name

String

The key based PCG user group name

HTTP Request

POST /pcgs/key-based/network-policy-438086664193/users HTTP/1.1
Content-Length: 130
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyOSwiZXhwIjoxNzEyNzc4OTI5fQ.yzcRp_ZaypyTMPkxRe4ww9vCd2cFw6UJJjsng9vGJ8c
Content-Type: application/json
Content-Type: application/json

{
  "users" : [ {
    "name" : "candy",
    "email" : "candy@extremecloudiq.com",
    "user_group_name" : "room-201-group"
  } ]
}

HTTP Response

HTTP/1.1 202 Accepted
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/pcgs/key-based/network-policy-438086664193/users' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyOSwiZXhwIjoxNzEyNzc4OTI5fQ.yzcRp_ZaypyTMPkxRe4ww9vCd2cFw6UJJjsng9vGJ8c' \
    -H 'Content-Type: application/json' \
    -H 'Content-Type: application/json' \
    -d '{
  "users" : [ {
    "name" : "candy",
    "email" : "candy@extremecloudiq.com",
    "user_group_name" : "room-201-group"
  } ]
}'

Delete Key-based PCG users

DELETE /pcgs/key-based/network-policy-{policyId}/users

Path Parameters

Table 91. /pcgs/key-based/network-policy-{policyId}/users
Parameter	Description
`policyId`	The network policy ID

Request Fields

Path Type Description

user_ids

Array

The key based PCG user IDs

HTTP Request

DELETE /pcgs/key-based/network-policy-438086664193/users HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyOCwiZXhwIjoxNzEyNzc4OTI4fQ.CKRAbCrx4Z4c_k6cOoDlIGFV6clh_h8XX07vmSXRtps
Content-Length: 27
Content-Type: application/json
Content-Type: application/json

{
  "user_ids" : [ 1, 2 ]
}

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
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
RateLimit-Remaining: 7393

cURL Request

$ curl 'https://api.extremecloudiq.com/pcgs/key-based/network-policy-438086664193/users' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyOCwiZXhwIjoxNzEyNzc4OTI4fQ.CKRAbCrx4Z4c_k6cOoDlIGFV6clh_h8XX07vmSXRtps' \
    -H 'Content-Type: application/json' \
    -H 'Content-Type: application/json' \
    -d '{
  "user_ids" : [ 1, 2 ]
}'

List SMS templates

GET /sms-templates

Request Parameters

Parameter Description

password_type

The password type for filtering SMS templates

HTTP Request

GET /sms-templates HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyOCwiZXhwIjoxNzEyNzc4OTI4fQ.CKRAbCrx4Z4c_k6cOoDlIGFV6clh_h8XX07vmSXRtps
Content-Type: application/json

Response Fields

Path Type Description

[].id

Number

The SMS template ID

[].create_time

String

The create time

[].update_time

String

The last update time

[].org_id

Number

The organization identifier, valid when enabling HIQ feature

[].name

String

The name of SMS template

[].description

String

The description of SMS template

[].predefined

Boolean

Flag to describe whether the SMS template is predefined

[].content

String

The content of SMS template

[].password_type

String

The password type of SMS template

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
RateLimit-Remaining: 7399
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: 564

[ {
  "id" : 1,
  "create_time" : "2024-04-03T19:55:28.000+0000",
  "update_time" : "2024-04-03T19:55:28.000+0000",
  "org_id" : 0,
  "name" : "test-template-1",
  "description" : "test-template-1",
  "predefined" : false,
  "content" : "test content",
  "password_type" : "PPSK"
}, {
  "id" : 2,
  "create_time" : "2024-04-03T19:55:28.000+0000",
  "update_time" : "2024-04-03T19:55:28.000+0000",
  "org_id" : 0,
  "name" : "test-template-2",
  "description" : "test-template-2",
  "predefined" : false,
  "content" : "test content",
  "password_type" : "PPSK"
} ]

cURL Request

$ curl 'https://api.extremecloudiq.com/sms-templates' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyOCwiZXhwIjoxNzEyNzc4OTI4fQ.CKRAbCrx4Z4c_k6cOoDlIGFV6clh_h8XX07vmSXRtps' \
    -H 'Content-Type: application/json'

List user groups

GET /usergroups

Request Parameters

Parameter Description

page

Page number

limit

Page size

user_group_ids

The user group IDs

HTTP Request

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

Response Fields

Path Type Description

page

Number

The current page number

count

Number

The element count of the current page

total_pages

Number

The total page number based on request page size

total_count

Number

The total element count

data[].id

Number

The user group ID

data[].create_time

String

The create time

data[].update_time

String

The last update time

data[].org_id

Number

The organization identifier, valid when enabling HIQ feature

data[].name

String

The name of user group

data[].predefined

Boolean

Flag to describe whether user group is predefined

data[].description

String

The description of user group

data[].password_db_location

String

The password DB location of user group

data[].password_type

String

The password type of user group

data[].pcg_type

String

The PCG type of user group

data[].pcg_use_only

Boolean

Flag to indicate only use PCG

data[].ppsk_use_only

Boolean

Flag to indicate only use PPSK

data[].enable_cwp_reg

Boolean

Flag to enable Captive Web Portals Registration

data[].password_settings.enable_letters

Boolean

Flag to enable use of letters

data[].password_settings.enable_numbers

Boolean

Flag to enable use of numbers

data[].password_settings.enable_special_characters

Boolean

Flag to enable use of special characters

data[].password_settings.password_character_types

String

Password generation using letters, numbers, and/or special characters

data[].password_settings.psk_generation_method

String

The PPSK generation method

data[].password_settings.password_length

Number

The maximum password length

data[].password_settings.password_concat_string

String

The password concat string

data[].expiration_settings.expiration_type

String

The setting for Never Expire option or null for other settings

data[].expiration_settings.valid_during_dates.start_date_time.day_of_month

Number

The day of month

data[].expiration_settings.valid_during_dates.start_date_time.month

Number

The month

data[].expiration_settings.valid_during_dates.start_date_time.year

Number

The year

data[].expiration_settings.valid_during_dates.start_date_time.hour_of_day

Number

The 24-hour format hour of day

data[].expiration_settings.valid_during_dates.start_date_time.minute_of_hour

Number

The minute of the hour

data[].expiration_settings.valid_during_dates.end_date_time.day_of_month

Number

The day of month

data[].expiration_settings.valid_during_dates.end_date_time.month

Number

The month

data[].expiration_settings.valid_during_dates.end_date_time.year

Number

The year

data[].expiration_settings.valid_during_dates.end_date_time.hour_of_day

Number

The 24-hour format hour of day

data[].expiration_settings.valid_during_dates.end_date_time.minute_of_hour

Number

The minute of the hour

data[].expiration_settings.valid_during_dates.time_zone

String

The time zone

data[].expiration_settings.valid_for_time_period.valid_time_period_after

String

The valid time period starting event

data[].expiration_settings.valid_for_time_period.after_id_creation_settings.valid_time_period

Number

The valid time period after account creation

data[].expiration_settings.valid_for_time_period.after_id_creation_settings.valid_time_period_unit

String

The time period unit

data[].expiration_settings.valid_for_time_period.after_first_login_settings.valid_time_period

Number

The valid time period after the first login

data[].expiration_settings.valid_for_time_period.after_first_login_settings.valid_time_period_unit

String

The time period unit

data[].expiration_settings.valid_for_time_period.after_first_login_settings.first_login_within

Number

The first time the access key must be used

data[].expiration_settings.valid_for_time_period.after_first_login_settings.first_login_within_unit

String

The access key must use time unit

data[].expiration_settings.valid_daily.daily_start_hour

Number

The 24-hour format start hour of the day

data[].expiration_settings.valid_daily.daily_start_minute

Number

The minute of the hour

data[].expiration_settings.valid_daily.daily_end_hour

Number

The 24-hour format end hour of day the end

data[].expiration_settings.valid_daily.daily_end_minute

Number

The minute of the hour

data[].expiration_settings.expiration_action

String

The Expiration Action to take, null if the account is never expired

data[].expiration_settings.post_expiration_action.enable_credentials_renewal

Boolean

The renew user credentials option or null for other option

data[].expiration_settings.post_expiration_action.enable_delete_immediately

Boolean

The immediate delete option or null to schedule the delete

data[].expiration_settings.post_expiration_action.delete_after_value

Number

The scheduled delete after expiration

data[].expiration_settings.post_expiration_action.delete_after_unit

String

The unit of time

data[].delivery_settings.email_template_id

Number

The Email Template ID

data[].delivery_settings.sms_template_id

Number

The SMS Template ID

data[].user_count

Number

The user count

data[].ssids

Array

The ssids

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

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 1,
  "total_count" : 2,
  "data" : [ {
    "id" : 1,
    "create_time" : "2024-04-03T19:55:28.000+0000",
    "update_time" : "2024-04-03T19:55:28.000+0000",
    "org_id" : 0,
    "name" : "test-user-profile-1",
    "description" : "test-user-profile-1",
    "predefined" : false,
    "password_db_location" : "CLOUD",
    "password_type" : "PPSK",
    "pcg_use_only" : false,
    "pcg_type" : "AP_BASED",
    "ppsk_use_only" : true,
    "enable_cwp_reg" : false,
    "password_settings" : {
      "enable_letters" : true,
      "enable_numbers" : true,
      "enable_special_characters" : true,
      "password_concat_string" : "-",
      "psk_generation_method" : "USER_STRING_PASSWORD",
      "password_character_types" : "INCLUDE_ALL_CHARACTER_TYPE_ENABLED",
      "password_length" : 10
    },
    "expiration_settings" : {
      "expiration_type" : "DAILY",
      "valid_during_dates" : {
        "start_date_time" : {
          "day_of_month" : 1,
          "month" : 7,
          "year" : 2021,
          "hour_of_day" : 10,
          "minute_of_hour" : 0
        },
        "end_date_time" : {
          "day_of_month" : 1,
          "month" : 7,
          "year" : 2021,
          "hour_of_day" : 10,
          "minute_of_hour" : 0
        },
        "time_zone" : "UTC"
      },
      "valid_for_time_period" : {
        "valid_time_period_after" : "FIRST_LOGIN",
        "after_id_creation_settings" : {
          "valid_time_period" : 2,
          "valid_time_period_unit" : "HOUR"
        },
        "after_first_login_settings" : {
          "valid_time_period" : 0,
          "valid_time_period_unit" : "HOUR",
          "first_login_within" : 2,
          "first_login_within_unit" : "HOUR"
        }
      },
      "valid_daily" : {
        "daily_start_hour" : 5,
        "daily_start_minute" : 1,
        "daily_end_hour" : 9,
        "daily_end_minute" : 59
      },
      "expiration_action" : "SHOW_MESSAGE",
      "post_expiration_action" : {
        "enable_credentials_renewal" : true,
        "enable_delete_immediately" : false,
        "delete_after_value" : 0,
        "delete_after_unit" : "HOUR"
      }
    },
    "delivery_settings" : {
      "email_template_id" : 1,
      "sms_template_id" : 1
    },
    "user_count" : 5,
    "ssids" : [ "ssid1", "ssid2" ]
  }, {
    "id" : 2,
    "create_time" : "2024-04-03T19:55:28.000+0000",
    "update_time" : "2024-04-03T19:55:28.000+0000",
    "org_id" : 0,
    "name" : "test-user-profile-2",
    "description" : "test-user-profile-2",
    "predefined" : false,
    "password_db_location" : "CLOUD",
    "password_type" : "PPSK",
    "pcg_use_only" : false,
    "pcg_type" : "AP_BASED",
    "ppsk_use_only" : true,
    "enable_cwp_reg" : false,
    "password_settings" : {
      "enable_letters" : true,
      "enable_numbers" : true,
      "enable_special_characters" : true,
      "password_concat_string" : "-",
      "psk_generation_method" : "USER_STRING_PASSWORD",
      "password_character_types" : "INCLUDE_ALL_CHARACTER_TYPE_ENABLED",
      "password_length" : 10
    },
    "expiration_settings" : {
      "expiration_type" : "DAILY",
      "valid_during_dates" : {
        "start_date_time" : {
          "day_of_month" : 1,
          "month" : 7,
          "year" : 2021,
          "hour_of_day" : 10,
          "minute_of_hour" : 0
        },
        "end_date_time" : {
          "day_of_month" : 1,
          "month" : 7,
          "year" : 2021,
          "hour_of_day" : 10,
          "minute_of_hour" : 0
        },
        "time_zone" : "UTC"
      },
      "valid_for_time_period" : {
        "valid_time_period_after" : "FIRST_LOGIN",
        "after_id_creation_settings" : {
          "valid_time_period" : 2,
          "valid_time_period_unit" : "HOUR"
        },
        "after_first_login_settings" : {
          "valid_time_period" : 0,
          "valid_time_period_unit" : "HOUR",
          "first_login_within" : 2,
          "first_login_within_unit" : "HOUR"
        }
      },
      "valid_daily" : {
        "daily_start_hour" : 5,
        "daily_start_minute" : 1,
        "daily_end_hour" : 9,
        "daily_end_minute" : 59
      },
      "expiration_action" : "SHOW_MESSAGE",
      "post_expiration_action" : {
        "enable_credentials_renewal" : true,
        "enable_delete_immediately" : false,
        "delete_after_value" : 0,
        "delete_after_unit" : "HOUR"
      }
    },
    "delivery_settings" : {
      "email_template_id" : 1,
      "sms_template_id" : 1
    },
    "user_count" : 5,
    "ssids" : [ "ssid1", "ssid2" ]
  } ]
}

cURL Request

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

Create user group

POST /usergroups

Request Fields

Path Type Description

name

String

The name of user group

description

String

The description of user group

password_db_location

String

The password DB location of user group

password_type

String

The password type of user group

enable_max_clients_per_ppsk

Boolean

Flag to enable max clients per PPSK

max_clients_per_ppsk

Number

The maximum clients count per PPSK

pcg_type

String

The PCG type of user group

pcg_use_only

Boolean

Flag to indicate only use PCG

ppsk_use_only

Boolean

Flag to indicate only use PPSK

enable_cwp_reg

Boolean

Flag to enable Captive Web Portals Registration

password_settings.enable_letters

Boolean

Flag to enable use of letters

password_settings.enable_numbers

Boolean

Flag to enable use of numbers

password_settings.enable_special_characters

Boolean

Flag to enable use of special characters

password_settings.password_character_types

String

Password generation using letters, numbers, and/or special characters

password_settings.psk_generation_method

String

The PPSK generation method

password_settings.password_length

Number

The maximum password length

password_settings.password_concat_string

String

The password concat string

expiration_settings.expiration_type

String

The setting for Never Expire option or null for other settings

expiration_settings.valid_during_dates.start_date_time.day_of_month

Number

The day of month

expiration_settings.valid_during_dates.start_date_time.month

Number

The month

expiration_settings.valid_during_dates.start_date_time.year

Number

The year

expiration_settings.valid_during_dates.start_date_time.hour_of_day

Number

The 24-hour format hour of day

expiration_settings.valid_during_dates.start_date_time.minute_of_hour

Number

The minute of the hour

expiration_settings.valid_during_dates.end_date_time.day_of_month

Number

The day of month

expiration_settings.valid_during_dates.end_date_time.month

Number

The month

expiration_settings.valid_during_dates.end_date_time.year

Number

The year

expiration_settings.valid_during_dates.end_date_time.hour_of_day

Number

The 24-hour format hour of day

expiration_settings.valid_during_dates.end_date_time.minute_of_hour

Number

The minute of the hour

expiration_settings.valid_during_dates.time_zone

String

The time zone

expiration_settings.valid_for_time_period.valid_time_period_after

String

The valid time period starting event

expiration_settings.valid_for_time_period.after_id_creation_settings.valid_time_period

Number

The valid time period after account creation

expiration_settings.valid_for_time_period.after_id_creation_settings.valid_time_period_unit

String

The time period unit

expiration_settings.valid_for_time_period.after_first_login_settings.valid_time_period

Number

The valid time period after the first login

expiration_settings.valid_for_time_period.after_first_login_settings.valid_time_period_unit

String

The time period unit

expiration_settings.valid_for_time_period.after_first_login_settings.first_login_within

Number

The first time the access key must be used

expiration_settings.valid_for_time_period.after_first_login_settings.first_login_within_unit

String

The access key must use time unit

expiration_settings.valid_daily.daily_start_hour

Number

The 24-hour format start hour of the day

expiration_settings.valid_daily.daily_start_minute

Number

The minute of the hour

expiration_settings.valid_daily.daily_end_hour

Number

The 24-hour format end hour of day the end

expiration_settings.valid_daily.daily_end_minute

Number

The minute of the hour

expiration_settings.expiration_action

String

The Expiration Action to take, null if the account is never expired

expiration_settings.post_expiration_action.enable_credentials_renewal

Boolean

The renew user credentials option or null for other option

expiration_settings.post_expiration_action.enable_delete_immediately

Boolean

The immediate delete option or null to schedule the delete

expiration_settings.post_expiration_action.delete_after_value

Number

The scheduled delete after expiration

expiration_settings.post_expiration_action.delete_after_unit

String

The unit of time

delivery_settings.email_template_id

Number

The Email Template ID

delivery_settings.sms_template_id

Number

The SMS Template ID

HTTP Request

POST /usergroups HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyOCwiZXhwIjoxNzEyNzc4OTI4fQ.CKRAbCrx4Z4c_k6cOoDlIGFV6clh_h8XX07vmSXRtps
Content-Type: application/json
Content-Length: 1974

{
  "name" : "test-user-profile-1",
  "description" : "test-user-profile-1",
  "password_db_location" : "CLOUD",
  "ppsk_use_only" : true,
  "password_type" : "PPSK",
  "enable_max_clients_per_ppsk" : true,
  "max_clients_per_ppsk" : 20,
  "pcg_use_only" : false,
  "pcg_type" : "AP_BASED",
  "enable_cwp_reg" : false,
  "password_settings" : {
    "enable_letters" : true,
    "enable_numbers" : true,
    "enable_special_characters" : true,
    "password_concat_string" : "-",
    "psk_generation_method" : "USER_STRING_PASSWORD",
    "password_character_types" : "INCLUDE_ALL_CHARACTER_TYPE_ENABLED",
    "password_length" : 10
  },
  "expiration_settings" : {
    "expiration_type" : "DAILY",
    "valid_during_dates" : {
      "start_date_time" : {
        "day_of_month" : 1,
        "month" : 7,
        "year" : 2021,
        "hour_of_day" : 10,
        "minute_of_hour" : 0
      },
      "end_date_time" : {
        "day_of_month" : 1,
        "month" : 7,
        "year" : 2021,
        "hour_of_day" : 10,
        "minute_of_hour" : 0
      },
      "time_zone" : "UTC"
    },
    "valid_for_time_period" : {
      "valid_time_period_after" : "FIRST_LOGIN",
      "after_id_creation_settings" : {
        "valid_time_period" : 2,
        "valid_time_period_unit" : "HOUR"
      },
      "after_first_login_settings" : {
        "valid_time_period" : 3,
        "valid_time_period_unit" : "HOUR",
        "first_login_within" : 2,
        "first_login_within_unit" : "HOUR"
      }
    },
    "valid_daily" : {
      "daily_start_hour" : 5,
      "daily_start_minute" : 1,
      "daily_end_hour" : 9,
      "daily_end_minute" : 59
    },
    "expiration_action" : "SHOW_MESSAGE",
    "post_expiration_action" : {
      "enable_credentials_renewal" : true,
      "enable_delete_immediately" : false,
      "delete_after_value" : 2,
      "delete_after_unit" : "HOUR"
    }
  },
  "delivery_settings" : {
    "email_template_id" : 1,
    "sms_template_id" : 1
  }
}

Response Fields

Path Type Description

id

Number

The user group ID

create_time

String

The create time

update_time

String

The last update time

org_id

Number

The organization identifier, valid when enabling HIQ feature

name

String

The name of user group

predefined

Boolean

Flag to describe whether user group is predefined

description

String

The description of user group

password_db_location

String

The password DB location of user group

password_type

String

The password type of user group

pcg_type

String

The PCG type of user group

pcg_use_only

Boolean

Flag to indicate only use PCG

ppsk_use_only

Boolean

Flag to indicate only use PPSK

enable_cwp_reg

Boolean

Flag to enable Captive Web Portals Registration

password_settings.enable_letters

Boolean

Flag to enable use of letters

password_settings.enable_numbers

Boolean

Flag to enable use of numbers

password_settings.enable_special_characters

Boolean

Flag to enable use of special characters

password_settings.password_character_types

String

Password generation using letters, numbers, and/or special characters

password_settings.psk_generation_method

String

The PPSK generation method

password_settings.password_length

Number

The maximum password length

password_settings.password_concat_string

String

The password concat string

expiration_settings.expiration_type

String

The setting for Never Expire option or null for other settings

expiration_settings.valid_during_dates.start_date_time.day_of_month

Number

The day of month

expiration_settings.valid_during_dates.start_date_time.month

Number

The month

expiration_settings.valid_during_dates.start_date_time.year

Number

The year

expiration_settings.valid_during_dates.start_date_time.hour_of_day

Number

The 24-hour format hour of day

expiration_settings.valid_during_dates.start_date_time.minute_of_hour

Number

The minute of the hour

expiration_settings.valid_during_dates.end_date_time.day_of_month

Number

The day of month

expiration_settings.valid_during_dates.end_date_time.month

Number

The month

expiration_settings.valid_during_dates.end_date_time.year

Number

The year

expiration_settings.valid_during_dates.end_date_time.hour_of_day

Number

The 24-hour format hour of day

expiration_settings.valid_during_dates.end_date_time.minute_of_hour

Number

The minute of the hour

expiration_settings.valid_during_dates.time_zone

String

The time zone

expiration_settings.valid_for_time_period.valid_time_period_after

String

The valid time period starting event

expiration_settings.valid_for_time_period.after_id_creation_settings.valid_time_period

Number

The valid time period after account creation

expiration_settings.valid_for_time_period.after_id_creation_settings.valid_time_period_unit

String

The time period unit

expiration_settings.valid_for_time_period.after_first_login_settings.valid_time_period

Number

The valid time period after the first login

expiration_settings.valid_for_time_period.after_first_login_settings.valid_time_period_unit

String

The time period unit

expiration_settings.valid_for_time_period.after_first_login_settings.first_login_within

Number

The first time the access key must be used

expiration_settings.valid_for_time_period.after_first_login_settings.first_login_within_unit

String

The access key must use time unit

expiration_settings.valid_daily.daily_start_hour

Number

The 24-hour format start hour of the day

expiration_settings.valid_daily.daily_start_minute

Number

The minute of the hour

expiration_settings.valid_daily.daily_end_hour

Number

The 24-hour format end hour of day the end

expiration_settings.valid_daily.daily_end_minute

Number

The minute of the hour

expiration_settings.expiration_action

String

The Expiration Action to take, null if the account is never expired

expiration_settings.post_expiration_action.enable_credentials_renewal

Boolean

The renew user credentials option or null for other option

expiration_settings.post_expiration_action.enable_delete_immediately

Boolean

The immediate delete option or null to schedule the delete

expiration_settings.post_expiration_action.delete_after_value

Number

The scheduled delete after expiration

expiration_settings.post_expiration_action.delete_after_unit

String

The unit of time

delivery_settings.email_template_id

Number

The Email Template ID

delivery_settings.sms_template_id

Number

The SMS Template ID

user_count

Number

The user count

ssids

Array

The ssids

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

{
  "id" : 1,
  "create_time" : "2024-04-03T19:55:28.000+0000",
  "update_time" : "2024-04-03T19:55:28.000+0000",
  "org_id" : 0,
  "name" : "test-user-profile-1",
  "description" : "test-user-profile-1",
  "predefined" : false,
  "password_db_location" : "CLOUD",
  "password_type" : "PPSK",
  "pcg_use_only" : false,
  "pcg_type" : "AP_BASED",
  "ppsk_use_only" : true,
  "enable_cwp_reg" : false,
  "password_settings" : {
    "enable_letters" : true,
    "enable_numbers" : true,
    "enable_special_characters" : true,
    "password_concat_string" : "-",
    "psk_generation_method" : "USER_STRING_PASSWORD",
    "password_character_types" : "INCLUDE_ALL_CHARACTER_TYPE_ENABLED",
    "password_length" : 10
  },
  "expiration_settings" : {
    "expiration_type" : "DAILY",
    "valid_during_dates" : {
      "start_date_time" : {
        "day_of_month" : 1,
        "month" : 7,
        "year" : 2021,
        "hour_of_day" : 10,
        "minute_of_hour" : 0
      },
      "end_date_time" : {
        "day_of_month" : 1,
        "month" : 7,
        "year" : 2021,
        "hour_of_day" : 10,
        "minute_of_hour" : 0
      },
      "time_zone" : "UTC"
    },
    "valid_for_time_period" : {
      "valid_time_period_after" : "FIRST_LOGIN",
      "after_id_creation_settings" : {
        "valid_time_period" : 2,
        "valid_time_period_unit" : "HOUR"
      },
      "after_first_login_settings" : {
        "valid_time_period" : 0,
        "valid_time_period_unit" : "HOUR",
        "first_login_within" : 2,
        "first_login_within_unit" : "HOUR"
      }
    },
    "valid_daily" : {
      "daily_start_hour" : 5,
      "daily_start_minute" : 1,
      "daily_end_hour" : 9,
      "daily_end_minute" : 59
    },
    "expiration_action" : "SHOW_MESSAGE",
    "post_expiration_action" : {
      "enable_credentials_renewal" : true,
      "enable_delete_immediately" : false,
      "delete_after_value" : 0,
      "delete_after_unit" : "HOUR"
    }
  },
  "delivery_settings" : {
    "email_template_id" : 1,
    "sms_template_id" : 1
  },
  "user_count" : 5,
  "ssids" : [ "ssid1", "ssid2" ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/usergroups' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyOCwiZXhwIjoxNzEyNzc4OTI4fQ.CKRAbCrx4Z4c_k6cOoDlIGFV6clh_h8XX07vmSXRtps' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "test-user-profile-1",
  "description" : "test-user-profile-1",
  "password_db_location" : "CLOUD",
  "ppsk_use_only" : true,
  "password_type" : "PPSK",
  "enable_max_clients_per_ppsk" : true,
  "max_clients_per_ppsk" : 20,
  "pcg_use_only" : false,
  "pcg_type" : "AP_BASED",
  "enable_cwp_reg" : false,
  "password_settings" : {
    "enable_letters" : true,
    "enable_numbers" : true,
    "enable_special_characters" : true,
    "password_concat_string" : "-",
    "psk_generation_method" : "USER_STRING_PASSWORD",
    "password_character_types" : "INCLUDE_ALL_CHARACTER_TYPE_ENABLED",
    "password_length" : 10
  },
  "expiration_settings" : {
    "expiration_type" : "DAILY",
    "valid_during_dates" : {
      "start_date_time" : {
        "day_of_month" : 1,
        "month" : 7,
        "year" : 2021,
        "hour_of_day" : 10,
        "minute_of_hour" : 0
      },
      "end_date_time" : {
        "day_of_month" : 1,
        "month" : 7,
        "year" : 2021,
        "hour_of_day" : 10,
        "minute_of_hour" : 0
      },
      "time_zone" : "UTC"
    },
    "valid_for_time_period" : {
      "valid_time_period_after" : "FIRST_LOGIN",
      "after_id_creation_settings" : {
        "valid_time_period" : 2,
        "valid_time_period_unit" : "HOUR"
      },
      "after_first_login_settings" : {
        "valid_time_period" : 3,
        "valid_time_period_unit" : "HOUR",
        "first_login_within" : 2,
        "first_login_within_unit" : "HOUR"
      }
    },
    "valid_daily" : {
      "daily_start_hour" : 5,
      "daily_start_minute" : 1,
      "daily_end_hour" : 9,
      "daily_end_minute" : 59
    },
    "expiration_action" : "SHOW_MESSAGE",
    "post_expiration_action" : {
      "enable_credentials_renewal" : true,
      "enable_delete_immediately" : false,
      "delete_after_value" : 2,
      "delete_after_unit" : "HOUR"
    }
  },
  "delivery_settings" : {
    "email_template_id" : 1,
    "sms_template_id" : 1
  }
}'

Update user group

PUT /usergroups/{id}

Path Parameters

Table 92. /usergroups/{id}
Parameter	Description
`id`	The user group ID

Request Fields

Path Type Description

name

String

The name of user group

description

String

The description of user group

password_db_location

String

The password DB location of user group

password_type

String

The password type of user group

enable_max_clients_per_ppsk

Boolean

Flag to enable max clients per PPSK

max_clients_per_ppsk

Number

The maximum clients count per PPSK

pcg_type

String

The PCG type of user group

pcg_use_only

Boolean

Flag to indicate only use PCG

ppsk_use_only

Boolean

Flag to indicate only use PPSK

enable_cwp_reg

Boolean

Flag to enable Captive Web Portals Registration

password_settings.enable_letters

Boolean

Flag to enable use of letters

password_settings.enable_numbers

Boolean

Flag to enable use of numbers

password_settings.enable_special_characters

Boolean

Flag to enable use of special characters

password_settings.password_character_types

String

Password generation using letters, numbers, and/or special characters

password_settings.psk_generation_method

String

The PPSK generation method

password_settings.password_length

Number

The maximum password length

password_settings.password_concat_string

String

The password concat string

expiration_settings.expiration_type

String

The setting for Never Expire option or null for other settings

expiration_settings.valid_during_dates.start_date_time.day_of_month

Number

The day of month

expiration_settings.valid_during_dates.start_date_time.month

Number

The month

expiration_settings.valid_during_dates.start_date_time.year

Number

The year

expiration_settings.valid_during_dates.start_date_time.hour_of_day

Number

The 24-hour format hour of day

expiration_settings.valid_during_dates.start_date_time.minute_of_hour

Number

The minute of the hour

expiration_settings.valid_during_dates.end_date_time.day_of_month

Number

The day of month

expiration_settings.valid_during_dates.end_date_time.month

Number

The month

expiration_settings.valid_during_dates.end_date_time.year

Number

The year

expiration_settings.valid_during_dates.end_date_time.hour_of_day

Number

The 24-hour format hour of day

expiration_settings.valid_during_dates.end_date_time.minute_of_hour

Number

The minute of the hour

expiration_settings.valid_during_dates.time_zone

String

The time zone

expiration_settings.valid_for_time_period.valid_time_period_after

String

The valid time period starting event

expiration_settings.valid_for_time_period.after_id_creation_settings.valid_time_period

Number

The valid time period after account creation

expiration_settings.valid_for_time_period.after_id_creation_settings.valid_time_period_unit

String

The time period unit

expiration_settings.valid_for_time_period.after_first_login_settings.valid_time_period

Number

The valid time period after the first login

expiration_settings.valid_for_time_period.after_first_login_settings.valid_time_period_unit

String

The time period unit

expiration_settings.valid_for_time_period.after_first_login_settings.first_login_within

Number

The first time the access key must be used

expiration_settings.valid_for_time_period.after_first_login_settings.first_login_within_unit

String

The access key must use time unit

expiration_settings.valid_daily.daily_start_hour

Number

The 24-hour format start hour of the day

expiration_settings.valid_daily.daily_start_minute

Number

The minute of the hour

expiration_settings.valid_daily.daily_end_hour

Number

The 24-hour format end hour of day the end

expiration_settings.valid_daily.daily_end_minute

Number

The minute of the hour

expiration_settings.expiration_action

String

The Expiration Action to take, null if the account is never expired

expiration_settings.post_expiration_action.enable_credentials_renewal

Boolean

The renew user credentials option or null for other option

expiration_settings.post_expiration_action.enable_delete_immediately

Boolean

The immediate delete option or null to schedule the delete

expiration_settings.post_expiration_action.delete_after_value

Number

The scheduled delete after expiration

expiration_settings.post_expiration_action.delete_after_unit

String

The unit of time

delivery_settings.email_template_id

Number

The Email Template ID

delivery_settings.sms_template_id

Number

The SMS Template ID

HTTP Request

PUT /usergroups/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyOCwiZXhwIjoxNzEyNzc4OTI4fQ.CKRAbCrx4Z4c_k6cOoDlIGFV6clh_h8XX07vmSXRtps
Content-Type: application/json
Content-Length: 1974

{
  "name" : "test-user-profile-1",
  "description" : "test-user-profile-1",
  "password_db_location" : "CLOUD",
  "ppsk_use_only" : true,
  "password_type" : "PPSK",
  "enable_max_clients_per_ppsk" : true,
  "max_clients_per_ppsk" : 20,
  "pcg_use_only" : false,
  "pcg_type" : "AP_BASED",
  "enable_cwp_reg" : false,
  "password_settings" : {
    "enable_letters" : true,
    "enable_numbers" : true,
    "enable_special_characters" : true,
    "password_concat_string" : "-",
    "psk_generation_method" : "USER_STRING_PASSWORD",
    "password_character_types" : "INCLUDE_ALL_CHARACTER_TYPE_ENABLED",
    "password_length" : 10
  },
  "expiration_settings" : {
    "expiration_type" : "DAILY",
    "valid_during_dates" : {
      "start_date_time" : {
        "day_of_month" : 1,
        "month" : 7,
        "year" : 2021,
        "hour_of_day" : 10,
        "minute_of_hour" : 0
      },
      "end_date_time" : {
        "day_of_month" : 1,
        "month" : 7,
        "year" : 2021,
        "hour_of_day" : 10,
        "minute_of_hour" : 0
      },
      "time_zone" : "UTC"
    },
    "valid_for_time_period" : {
      "valid_time_period_after" : "FIRST_LOGIN",
      "after_id_creation_settings" : {
        "valid_time_period" : 2,
        "valid_time_period_unit" : "HOUR"
      },
      "after_first_login_settings" : {
        "valid_time_period" : 3,
        "valid_time_period_unit" : "HOUR",
        "first_login_within" : 2,
        "first_login_within_unit" : "HOUR"
      }
    },
    "valid_daily" : {
      "daily_start_hour" : 5,
      "daily_start_minute" : 1,
      "daily_end_hour" : 9,
      "daily_end_minute" : 59
    },
    "expiration_action" : "SHOW_MESSAGE",
    "post_expiration_action" : {
      "enable_credentials_renewal" : true,
      "enable_delete_immediately" : false,
      "delete_after_value" : 2,
      "delete_after_unit" : "HOUR"
    }
  },
  "delivery_settings" : {
    "email_template_id" : 1,
    "sms_template_id" : 1
  }
}

Response Fields

Path Type Description

id

Number

The user group ID

create_time

String

The create time

update_time

String

The last update time

org_id

Number

The organization identifier, valid when enabling HIQ feature

name

String

The name of user group

predefined

Boolean

Flag to describe whether user group is predefined

description

String

The description of user group

password_db_location

String

The password DB location of user group

password_type

String

The password type of user group

pcg_type

String

The PCG type of user group

pcg_use_only

Boolean

Flag to indicate only use PCG

ppsk_use_only

Boolean

Flag to indicate only use PPSK

enable_cwp_reg

Boolean

Flag to enable Captive Web Portals Registration

password_settings.enable_letters

Boolean

Flag to enable use of letters

password_settings.enable_numbers

Boolean

Flag to enable use of numbers

password_settings.enable_special_characters

Boolean

Flag to enable use of special characters

password_settings.password_character_types

String

Password generation using letters, numbers, and/or special characters

password_settings.psk_generation_method

String

The PPSK generation method

password_settings.password_length

Number

The maximum password length

password_settings.password_concat_string

String

The password concat string

expiration_settings.expiration_type

String

The setting for Never Expire option or null for other settings

expiration_settings.valid_during_dates.start_date_time.day_of_month

Number

The day of month

expiration_settings.valid_during_dates.start_date_time.month

Number

The month

expiration_settings.valid_during_dates.start_date_time.year

Number

The year

expiration_settings.valid_during_dates.start_date_time.hour_of_day

Number

The 24-hour format hour of day

expiration_settings.valid_during_dates.start_date_time.minute_of_hour

Number

The minute of the hour

expiration_settings.valid_during_dates.end_date_time.day_of_month

Number

The day of month

expiration_settings.valid_during_dates.end_date_time.month

Number

The month

expiration_settings.valid_during_dates.end_date_time.year

Number

The year

expiration_settings.valid_during_dates.end_date_time.hour_of_day

Number

The 24-hour format hour of day

expiration_settings.valid_during_dates.end_date_time.minute_of_hour

Number

The minute of the hour

expiration_settings.valid_during_dates.time_zone

String

The time zone

expiration_settings.valid_for_time_period.valid_time_period_after

String

The valid time period starting event

expiration_settings.valid_for_time_period.after_id_creation_settings.valid_time_period

Number

The valid time period after account creation

expiration_settings.valid_for_time_period.after_id_creation_settings.valid_time_period_unit

String

The time period unit

expiration_settings.valid_for_time_period.after_first_login_settings.valid_time_period

Number

The valid time period after the first login

expiration_settings.valid_for_time_period.after_first_login_settings.valid_time_period_unit

String

The time period unit

expiration_settings.valid_for_time_period.after_first_login_settings.first_login_within

Number

The first time the access key must be used

expiration_settings.valid_for_time_period.after_first_login_settings.first_login_within_unit

String

The access key must use time unit

expiration_settings.valid_daily.daily_start_hour

Number

The 24-hour format start hour of the day

expiration_settings.valid_daily.daily_start_minute

Number

The minute of the hour

expiration_settings.valid_daily.daily_end_hour

Number

The 24-hour format end hour of day the end

expiration_settings.valid_daily.daily_end_minute

Number

The minute of the hour

expiration_settings.expiration_action

String

The Expiration Action to take, null if the account is never expired

expiration_settings.post_expiration_action.enable_credentials_renewal

Boolean

The renew user credentials option or null for other option

expiration_settings.post_expiration_action.enable_delete_immediately

Boolean

The immediate delete option or null to schedule the delete

expiration_settings.post_expiration_action.delete_after_value

Number

The scheduled delete after expiration

expiration_settings.post_expiration_action.delete_after_unit

String

The unit of time

delivery_settings.email_template_id

Number

The Email Template ID

delivery_settings.sms_template_id

Number

The SMS Template ID

user_count

Number

The user count

ssids

Array

The ssids

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
Content-Length: 2109
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
RateLimit-Remaining: 7395

{
  "id" : 1,
  "create_time" : "2024-04-03T19:55:28.000+0000",
  "update_time" : "2024-04-03T19:55:28.000+0000",
  "org_id" : 0,
  "name" : "test-user-profile-1",
  "description" : "test-user-profile-1",
  "predefined" : false,
  "password_db_location" : "CLOUD",
  "password_type" : "PPSK",
  "pcg_use_only" : false,
  "pcg_type" : "AP_BASED",
  "ppsk_use_only" : true,
  "enable_cwp_reg" : false,
  "password_settings" : {
    "enable_letters" : true,
    "enable_numbers" : true,
    "enable_special_characters" : true,
    "password_concat_string" : "-",
    "psk_generation_method" : "USER_STRING_PASSWORD",
    "password_character_types" : "INCLUDE_ALL_CHARACTER_TYPE_ENABLED",
    "password_length" : 10
  },
  "expiration_settings" : {
    "expiration_type" : "DAILY",
    "valid_during_dates" : {
      "start_date_time" : {
        "day_of_month" : 1,
        "month" : 7,
        "year" : 2021,
        "hour_of_day" : 10,
        "minute_of_hour" : 0
      },
      "end_date_time" : {
        "day_of_month" : 1,
        "month" : 7,
        "year" : 2021,
        "hour_of_day" : 10,
        "minute_of_hour" : 0
      },
      "time_zone" : "UTC"
    },
    "valid_for_time_period" : {
      "valid_time_period_after" : "FIRST_LOGIN",
      "after_id_creation_settings" : {
        "valid_time_period" : 2,
        "valid_time_period_unit" : "HOUR"
      },
      "after_first_login_settings" : {
        "valid_time_period" : 0,
        "valid_time_period_unit" : "HOUR",
        "first_login_within" : 2,
        "first_login_within_unit" : "HOUR"
      }
    },
    "valid_daily" : {
      "daily_start_hour" : 5,
      "daily_start_minute" : 1,
      "daily_end_hour" : 9,
      "daily_end_minute" : 59
    },
    "expiration_action" : "SHOW_MESSAGE",
    "post_expiration_action" : {
      "enable_credentials_renewal" : true,
      "enable_delete_immediately" : false,
      "delete_after_value" : 0,
      "delete_after_unit" : "HOUR"
    }
  },
  "delivery_settings" : {
    "email_template_id" : 1,
    "sms_template_id" : 1
  },
  "user_count" : 5,
  "ssids" : [ "ssid1", "ssid2" ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/usergroups/438086664193' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyOCwiZXhwIjoxNzEyNzc4OTI4fQ.CKRAbCrx4Z4c_k6cOoDlIGFV6clh_h8XX07vmSXRtps' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "test-user-profile-1",
  "description" : "test-user-profile-1",
  "password_db_location" : "CLOUD",
  "ppsk_use_only" : true,
  "password_type" : "PPSK",
  "enable_max_clients_per_ppsk" : true,
  "max_clients_per_ppsk" : 20,
  "pcg_use_only" : false,
  "pcg_type" : "AP_BASED",
  "enable_cwp_reg" : false,
  "password_settings" : {
    "enable_letters" : true,
    "enable_numbers" : true,
    "enable_special_characters" : true,
    "password_concat_string" : "-",
    "psk_generation_method" : "USER_STRING_PASSWORD",
    "password_character_types" : "INCLUDE_ALL_CHARACTER_TYPE_ENABLED",
    "password_length" : 10
  },
  "expiration_settings" : {
    "expiration_type" : "DAILY",
    "valid_during_dates" : {
      "start_date_time" : {
        "day_of_month" : 1,
        "month" : 7,
        "year" : 2021,
        "hour_of_day" : 10,
        "minute_of_hour" : 0
      },
      "end_date_time" : {
        "day_of_month" : 1,
        "month" : 7,
        "year" : 2021,
        "hour_of_day" : 10,
        "minute_of_hour" : 0
      },
      "time_zone" : "UTC"
    },
    "valid_for_time_period" : {
      "valid_time_period_after" : "FIRST_LOGIN",
      "after_id_creation_settings" : {
        "valid_time_period" : 2,
        "valid_time_period_unit" : "HOUR"
      },
      "after_first_login_settings" : {
        "valid_time_period" : 3,
        "valid_time_period_unit" : "HOUR",
        "first_login_within" : 2,
        "first_login_within_unit" : "HOUR"
      }
    },
    "valid_daily" : {
      "daily_start_hour" : 5,
      "daily_start_minute" : 1,
      "daily_end_hour" : 9,
      "daily_end_minute" : 59
    },
    "expiration_action" : "SHOW_MESSAGE",
    "post_expiration_action" : {
      "enable_credentials_renewal" : true,
      "enable_delete_immediately" : false,
      "delete_after_value" : 2,
      "delete_after_unit" : "HOUR"
    }
  },
  "delivery_settings" : {
    "email_template_id" : 1,
    "sms_template_id" : 1
  }
}'

Delete user group

DELETE /usergroups/{id}

Path Parameters

Table 93. /usergroups/{id}
Parameter	Description
`id`	The user group ID

HTTP Request

DELETE /usergroups/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyOCwiZXhwIjoxNzEyNzc4OTI4fQ.CKRAbCrx4Z4c_k6cOoDlIGFV6clh_h8XX07vmSXRtps
Content-Type: application/json

HTTP Response

HTTP/1.1 200 OK
RateLimit-Remaining: 7396
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/usergroups/438086664193' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyOCwiZXhwIjoxNzEyNzc4OTI4fQ.CKRAbCrx4Z4c_k6cOoDlIGFV6clh_h8XX07vmSXRtps' \
    -H 'Content-Type: application/json'

Configuration - Policy

List cloud config groups

GET /ccgs

Request Parameters

Parameter Description

page

Page number

limit

Page size

HTTP Request

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

Response Fields

Path Type Description

page

Number

The current page number

count

Number

The element count of the current page

total_pages

Number

The total page number based on request page size

total_count

Number

The total element count

data[].id

Number

The Cloud Config Group ID

data[].create_time

String

The create time

data[].update_time

String

The last update time

data[].org_id

Number

The organization identifier, valid when enabling HIQ feature

data[].name

String

The name of Cloud Config Group

data[].description

String

The description of Cloud Config Group

data[].predefined

Boolean

Flag to describe whether the Cloud Config Group is predefined

data[].read_only

Boolean

Flag to describe whether the Cloud Config Group is read-only

data[].zone_id

Number

The zone ID of Cloud Config Group

data[].zone_location_id

Number

The zone location ID of Cloud Config Group

data[].zone_name

String

The zone name of Cloud Config Group

data[].device_ids

Array

The assigned device IDs

HTTP Response

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

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 1,
  "total_count" : 2,
  "data" : [ {
    "id" : 1,
    "create_time" : "2024-04-03T19:55:23.000+0000",
    "update_time" : "2024-04-03T19:55:23.000+0000",
    "org_id" : 0,
    "name" : "test-ccg-1",
    "description" : "test-ccg-1",
    "predefined" : false,
    "read_only" : false,
    "zone_name" : "test-zone",
    "zone_id" : 100,
    "zone_location_id" : 100,
    "device_ids" : [ 1, 2 ]
  }, {
    "id" : 2,
    "create_time" : "2024-04-03T19:55:23.000+0000",
    "update_time" : "2024-04-03T19:55:23.000+0000",
    "org_id" : 0,
    "name" : "test-ccg-2",
    "description" : "test-ccg-2",
    "predefined" : false,
    "read_only" : false,
    "zone_name" : "test-zone",
    "zone_id" : 100,
    "zone_location_id" : 100,
    "device_ids" : [ 1, 2 ]
  } ]
}

cURL Request

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

Create cloud config group

POST /ccgs

Request Fields

Path Type Description

name

String

The name of Cloud Config Group

description

String

The description of Cloud Config Group

device_ids

Array

The assigned device IDs

HTTP Request

POST /ccgs HTTP/1.1
Content-Length: 86
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyMywiZXhwIjoxNzEyNzc4OTIzfQ._18GIMcZ1PUzHT6ANaGgSFMpILZUg9KOpgJn7G8jeec

{
  "name" : "test-ccg-1",
  "description" : "test-ccg-1",
  "device_ids" : [ 1, 2 ]
}

Response Fields

Path Type Description

id

Number

The Cloud Config Group ID

create_time

String

The create time

update_time

String

The last update time

org_id

Number

The organization identifier, valid when enabling HIQ feature

name

String

The name of Cloud Config Group

description

String

The description of Cloud Config Group

predefined

Boolean

Flag to describe whether the Cloud Config Group is predefined

read_only

Boolean

Flag to describe whether the Cloud Config Group is read-only

zone_id

Number

The zone ID of Cloud Config Group

zone_location_id

Number

The zone location ID of Cloud Config Group

zone_name

String

The zone name of Cloud Config Group

device_ids

Array

The assigned device IDs

HTTP Response

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

{
  "id" : 1,
  "create_time" : "2024-04-03T19:55:23.000+0000",
  "update_time" : "2024-04-03T19:55:23.000+0000",
  "org_id" : 0,
  "name" : "test-ccg-1",
  "description" : "test-ccg-1",
  "predefined" : false,
  "read_only" : false,
  "zone_name" : "test-zone",
  "zone_id" : 100,
  "zone_location_id" : 100,
  "device_ids" : [ 1, 2 ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/ccgs' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyMywiZXhwIjoxNzEyNzc4OTIzfQ._18GIMcZ1PUzHT6ANaGgSFMpILZUg9KOpgJn7G8jeec' \
    -d '{
  "name" : "test-ccg-1",
  "description" : "test-ccg-1",
  "device_ids" : [ 1, 2 ]
}'

Get cloud config group

GET /ccgs/{id}

Path parameters

Table 94. /ccgs/{id}
Parameter	Description
`id`	The Cloud Config Group ID

HTTP Request

GET /ccgs/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyMywiZXhwIjoxNzEyNzc4OTIzfQ._18GIMcZ1PUzHT6ANaGgSFMpILZUg9KOpgJn7G8jeec

Response Fields

Path Type Description

id

Number

The Cloud Config Group ID

create_time

String

The create time

update_time

String

The last update time

org_id

Number

The organization identifier, valid when enabling HIQ feature

name

String

The name of Cloud Config Group

description

String

The description of Cloud Config Group

predefined

Boolean

Flag to describe whether the Cloud Config Group is predefined

read_only

Boolean

Flag to describe whether the Cloud Config Group is read-only

zone_id

Number

The zone ID of Cloud Config Group

zone_location_id

Number

The zone location ID of Cloud Config Group

zone_name

String

The zone name of Cloud Config Group

device_ids

Array

The assigned device IDs

HTTP Response

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

{
  "id" : 1,
  "create_time" : "2024-04-03T19:55:23.000+0000",
  "update_time" : "2024-04-03T19:55:23.000+0000",
  "org_id" : 0,
  "name" : "test-ccg-1",
  "description" : "test-ccg-1",
  "predefined" : false,
  "read_only" : false,
  "zone_name" : "test-zone",
  "zone_id" : 100,
  "zone_location_id" : 100,
  "device_ids" : [ 1, 2 ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/ccgs/438086664193' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyMywiZXhwIjoxNzEyNzc4OTIzfQ._18GIMcZ1PUzHT6ANaGgSFMpILZUg9KOpgJn7G8jeec'

Update cloud config group

PUT /ccgs/{id}

Path Parameters

Table 95. /ccgs/{id}
Parameter	Description
`id`	The Cloud Config Group ID

Request Fields

Path Type Description

name

String

The name of Cloud Config Group

description

String

The description of Cloud Config Group

device_ids

Array

The assigned device IDs

HTTP Request

PUT /ccgs/438086664193 HTTP/1.1
Content-Length: 86
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyMywiZXhwIjoxNzEyNzc4OTIzfQ._18GIMcZ1PUzHT6ANaGgSFMpILZUg9KOpgJn7G8jeec

{
  "name" : "test-ccg-1",
  "description" : "test-ccg-1",
  "device_ids" : [ 1, 2 ]
}

Response Fields

Path Type Description

id

Number

The Cloud Config Group ID

create_time

String

The create time

update_time

String

The last update time

org_id

Number

The organization identifier, valid when enabling HIQ feature

name

String

The name of Cloud Config Group

description

String

The description of Cloud Config Group

predefined

Boolean

Flag to describe whether the Cloud Config Group is predefined

read_only

Boolean

Flag to describe whether the Cloud Config Group is read-only

zone_id

Number

The zone ID of Cloud Config Group

zone_location_id

Number

The zone location ID of Cloud Config Group

zone_name

String

The zone name of Cloud Config Group

device_ids

Array

The assigned device IDs

HTTP Response

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

{
  "id" : 1,
  "create_time" : "2024-04-03T19:55:23.000+0000",
  "update_time" : "2024-04-03T19:55:23.000+0000",
  "org_id" : 0,
  "name" : "test-ccg-1",
  "description" : "test-ccg-1",
  "predefined" : false,
  "read_only" : false,
  "zone_name" : "test-zone",
  "zone_id" : 100,
  "zone_location_id" : 100,
  "device_ids" : [ 1, 2 ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/ccgs/438086664193' -i -X PUT \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyMywiZXhwIjoxNzEyNzc4OTIzfQ._18GIMcZ1PUzHT6ANaGgSFMpILZUg9KOpgJn7G8jeec' \
    -d '{
  "name" : "test-ccg-1",
  "description" : "test-ccg-1",
  "device_ids" : [ 1, 2 ]
}'

Delete cloud config group

DELETE /ccgs/{id}

Path Parameters

Table 96. /ccgs/{id}
Parameter	Description
`id`	The Cloud Config Group ID

HTTP Request

DELETE /ccgs/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyMywiZXhwIjoxNzEyNzc4OTIzfQ._18GIMcZ1PUzHT6ANaGgSFMpILZUg9KOpgJn7G8jeec

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: 7434
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/ccgs/438086664193' -i -X DELETE \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyMywiZXhwIjoxNzEyNzc4OTIzfQ._18GIMcZ1PUzHT6ANaGgSFMpILZUg9KOpgJn7G8jeec'

List classification rules

GET /classification-rules

Request Parameters

Parameter Description

page

Page number

limit

Page size

HTTP Request

GET /classification-rules?page=1&limit=10 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDExNiwiZXhwIjoxNzEyNzc4OTE2fQ.cmYenB4TyP3zkZOiTvD6SpL7UYTWe6CFP5ptCCqglD8
Content-Type: application/json

Response Fields

Path Type Description

page

Number

The current page number.

count

Number

The element count of the current page.

total_pages

Number

The total page number based on request page size.

total_count

Number

The total element count.

data[].id

Number

The classification assignment ID.

data[].org_id

Number

The classification assignment ID.

data[].create_time

String

The create time.

data[].update_time

String

The last update time.

data[].name

String

The name of classification assignment.

data[].description

String

The description.

data[].classifications[].id

Number

The classification id.

data[].classifications[].match

Boolean

Match or not match to the value.

data[].classifications[].value

String

The value of classification.

data[].classifications[].create_time

String

The classification create time.

data[].classifications[].update_time

String

The classification update time.

data[].classifications[].classification_type

String

The classification update time.

data[].classifications[].classification_id

Number

The classification id, could be: location ID, address profile ID or cloud config group ID.

HTTP Response

HTTP/1.1 200 OK
Content-Length: 2905
RateLimit-Remaining: 7496
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

{
  "page" : 1,
  "count" : 0,
  "total_pages" : 0,
  "total_count" : 0,
  "data" : [ {
    "id" : 1,
    "create_time" : "2024-04-03T19:55:16.000+0000",
    "update_time" : "2024-04-03T19:55:16.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" : 3,
      "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" : 4,
      "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" : 5,
      "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" : 6,
      "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" : 7,
      "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" : 8,
      "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" : 9,
      "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/classification-rules?page=1&limit=10' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDExNiwiZXhwIjoxNzEyNzc4OTE2fQ.cmYenB4TyP3zkZOiTvD6SpL7UYTWe6CFP5ptCCqglD8' \
    -H 'Content-Type: application/json'

Create classification rule

POST /classification-rules

Request Fields

Path Type Description

name

String

The classification assignment name

description

String

The description of classification assignment

classifications[].match

Boolean

The match or not match of classification

classifications[].classification_type

String

The classification type

classifications[].classification_type_id

Number

The classification id, could be: location ID, address profile ID or cloud config group ID

HTTP Request

POST /classification-rules HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDExNSwiZXhwIjoxNzEyNzc4OTE1fQ.rxvOY1cV9ExZZOft8j7qUTyP4I4Xb3OwgZuuF0yx88U
Content-Type: application/json
Content-Length: 334

{
  "name" : "test-co-ca-01",
  "description" : "Description.",
  "classifications" : [ {
    "classification_type" : "CLASSIFICATION_TYPE_IP_ADDRESS",
    "match" : true,
    "classification_type_id" : 0
  }, {
    "classification_type" : "CLASSIFICATION_TYPE_IP_ADDRESS",
    "match" : true,
    "classification_type_id" : 1
  } ]
}

Response Fields

Path Type Description

id

Number

The classification assignment ID

org_id

Number

The classification assignment org ID

name

String

The classification assignment name

description

String

The description of classification assignment

create_time

String

The create time

update_time

String

The update time

classifications[].id

Number

The ID of classification

classifications[].create_time

String

The classification create time

classifications[].update_time

String

The classification update time

classifications[].value

String

The value for the reference

classifications[].match

Boolean

The match or not match of classification

classifications[].classification_type

String

The classification type

classifications[].classification_id

Number

The classification id, could be: location ID, address profile ID or cloud config group ID

HTTP Response

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

{
  "id" : 1,
  "create_time" : "2024-04-03T19:55:15.000+0000",
  "update_time" : "2024-04-03T19:55:15.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"
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/classification-rules' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDExNSwiZXhwIjoxNzEyNzc4OTE1fQ.rxvOY1cV9ExZZOft8j7qUTyP4I4Xb3OwgZuuF0yx88U' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "test-co-ca-01",
  "description" : "Description.",
  "classifications" : [ {
    "classification_type" : "CLASSIFICATION_TYPE_IP_ADDRESS",
    "match" : true,
    "classification_type_id" : 0
  }, {
    "classification_type" : "CLASSIFICATION_TYPE_IP_ADDRESS",
    "match" : true,
    "classification_type_id" : 1
  } ]
}'

Get classification rule

GET /classification-rules/{id}

Path Parameters

Table 97. /classification-rules/{id}
Parameter	Description
`id`	The classification assignment ID

HTTP Request

GET /classification-rules/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDExNCwiZXhwIjoxNzEyNzc4OTE0fQ.6n4aF19_R-tJLoZ26-dtrRjnTs8rtwJp0Mj7gh3yOJE
Content-Type: application/json

Response Fields

Path Type Description

id

Number

The classification assignment ID.

org_id

Number

The classification assignment org ID.

create_time

String

The create time.

update_time

String

The last update time.

name

String

The classification assignment name

description

String

The description of classification assignment.

classifications[].id

Number

The classification id.

classifications[].match

Boolean

If match to the value.

classifications[].value

String

The value of classification.

classifications[].create_time

String

The classification create time.

classifications[].update_time

String

The classification update time.

classifications[].classification_type

String

The classification update time.

classifications[].classification_id

Number

The classification id, could be: location ID, address profile ID or cloud config group ID.

HTTP Response

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

{
  "id" : 1,
  "create_time" : "2024-04-03T19:55:15.000+0000",
  "update_time" : "2024-04-03T19:55:15.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/classification-rules/438086664193' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDExNCwiZXhwIjoxNzEyNzc4OTE0fQ.6n4aF19_R-tJLoZ26-dtrRjnTs8rtwJp0Mj7gh3yOJE' \
    -H 'Content-Type: application/json'

Update classification rule

PUT /classification-rules/{id}

Path Parameters

Table 98. /classification-rules/{id}
Parameter	Description
`id`	The classification assignment ID

Request Fields

Path Type Description

name

String

The classification assignment name

description

String

The description of classification assignment

classifications[].match

Boolean

The match or not match of classification

classifications[].classification_type

String

The classification type

classifications[].classification_type_id

Number

The classification id, could be: location ID, address profile ID or cloud config group ID

HTTP Request

PUT /classification-rules/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDExNiwiZXhwIjoxNzEyNzc4OTE2fQ.cmYenB4TyP3zkZOiTvD6SpL7UYTWe6CFP5ptCCqglD8
Content-Type: application/json
Content-Length: 334

{
  "name" : "test-co-ca-01",
  "description" : "Description.",
  "classifications" : [ {
    "classification_type" : "CLASSIFICATION_TYPE_IP_ADDRESS",
    "match" : true,
    "classification_type_id" : 0
  }, {
    "classification_type" : "CLASSIFICATION_TYPE_IP_ADDRESS",
    "match" : true,
    "classification_type_id" : 1
  } ]
}

Response Fields

Path Type Description

id

Number

The classification assignment ID

org_id

Number

The classification assignment org ID

name

String

The classification assignment name

description

String

The description of classification assignment

create_time

String

The create time

update_time

String

The update time

classifications[].id

Number

The ID of classification

classifications[].create_time

String

The classification create time

classifications[].update_time

String

The classification update time

classifications[].value

String

The value for the reference

classifications[].match

Boolean

The match or not match of classification

classifications[].classification_type

String

The classification type

classifications[].classification_id

Number

The classification id, could be: location ID, address profile ID or cloud config group ID

HTTP Response

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

{
  "id" : 1,
  "create_time" : "2024-04-03T19:55:16.000+0000",
  "update_time" : "2024-04-03T19:55:16.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"
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/classification-rules/438086664193' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDExNiwiZXhwIjoxNzEyNzc4OTE2fQ.cmYenB4TyP3zkZOiTvD6SpL7UYTWe6CFP5ptCCqglD8' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "test-co-ca-01",
  "description" : "Description.",
  "classifications" : [ {
    "classification_type" : "CLASSIFICATION_TYPE_IP_ADDRESS",
    "match" : true,
    "classification_type_id" : 0
  }, {
    "classification_type" : "CLASSIFICATION_TYPE_IP_ADDRESS",
    "match" : true,
    "classification_type_id" : 1
  } ]
}'

Delete classification rule

DELETE /classification-rules/{id}

Path Parameters

Table 99. /classification-rules/{id}
Parameter	Description
`id`	The classification assignment ID

HTTP Request

DELETE /classification-rules/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDExNSwiZXhwIjoxNzEyNzc4OTE1fQ.rxvOY1cV9ExZZOft8j7qUTyP4I4Xb3OwgZuuF0yx88U
Content-Type: application/json

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
RateLimit-Remaining: 7498
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/classification-rules/438086664193' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDExNSwiZXhwIjoxNzEyNzc4OTE1fQ.rxvOY1cV9ExZZOft8j7qUTyP4I4Xb3OwgZuuF0yx88U' \
    -H 'Content-Type: application/json'

List the L3 address profiles

GET /l3-address-profiles

Request Parameters

Parameter Description

addressType

The address type

HTTP Request

GET /l3-address-profiles?addressType=L3_ADDRESS_TYPE_IP_ADDRESS HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNCwiZXhwIjoxNzEyNzc4OTI0fQ.T0Vfd2v4NVXRKrv9Jc93gl5VztjKcLQpN6EqDDMKIyU

HTTP Response Fields

Path Type Description

[].id

Number

The address profile ID.

[].create_time

String

The timestamp when the location was created.

[].update_time

String

The timestamp when the location was last updated.

[].name

String

The location name.

[].address_type

String

The address profile type.

[]org_id

Number

The orgnaizationId

[]predefined

Boolean

[]description

String

The L3 Address profile Description

[]value

String

The L3 Address profile value

[]enable_classification

Boolean

The L3 Address profile boolean for classification

[]classified_entries

Array

The classified rule entries

HTTP Response

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

[ {
  "id" : 1,
  "create_time" : "2024-04-03T19:55:24.000+0000",
  "update_time" : "2024-04-03T19:55:24.000+0000",
  "org_id" : 0,
  "predefined" : false,
  "name" : "10.0.0.1",
  "description" : "",
  "value" : "",
  "enable_classification" : false,
  "address_type" : "IP_ADDRESS",
  "classified_entries" : [ ]
} ]

cURL Request

$ curl 'https://api.extremecloudiq.com/l3-address-profiles?addressType=L3_ADDRESS_TYPE_IP_ADDRESS' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNCwiZXhwIjoxNzEyNzc4OTI0fQ.T0Vfd2v4NVXRKrv9Jc93gl5VztjKcLQpN6EqDDMKIyU'

List SSIDs

GET /ssids

Request Parameters

Parameter Description

page

Page number

limit

Page size

HTTP Request

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

Response Fields

Path Type Description

page

Number

The current page number.

count

Number

The element count of the current page.

total_pages

Number

The total page number based on request page size.

total_count

Number

The total element count.

data[].id

Number

The SSID ID.

data[].create_time

String

The timestamp when the network policy was created.

data[].update_time

String

The timestamp when the network policy was last updated.

data[].org_id

Number

The Organization ID.

data[].name

String

The SSID profile name.

data[].broadcast_name

String

The SSID broadcast name.

data[].description

String

The SSID description.

data[].predefined

Boolean

Whether it is predefined.

data[].advanced_settings_id

Number

The SSID advanced settings ID.

data[].enable_user_profile_assignment

Boolean

Flag for enabling user profile assignment

data[].enable_radius_attribute_user_profile_assignment

Boolean

Flag for enabling radius attr with UPA

data[].attribute_key

Number

The SSID attribute key.

data[].access_security.key_value

String

The schedule type name.

data[].access_security.anti_logging_threshold

Number

The anti logging threshold value.

data[].access_security.transition_mode

Boolean

The flag for enabling transition mode.

data[].access_security.security_type

String

The security type.

data[].radius_client_profile.default_radius_client_object_id

Number

The default RADIUS client object ID.

data[].radius_client_profile.enable_classification

Boolean

The flag to enable classification entries on RADIUS client profile.

data[].radius_client_profile.classified_entries

Array

The RADIUS client profile classified entries.

data[].vendor_id

Number

The vendor id, when the Attribute type is CUSTOM.

data[].default_user_profile

Number

The default User Profile ID.

data[].user_profile_assignment_rules

Array

The SSID user profile assignment rules.

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
RateLimit-Remaining: 7476
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: 1788

{
  "page" : 2,
  "count" : 2,
  "total_pages" : 1,
  "total_count" : 2,
  "data" : [ {
    "id" : 10,
    "create_time" : "2024-04-03T19:55:18.000+0000",
    "update_time" : "2024-04-03T19:55:18.000+0000",
    "org_id" : 0,
    "name" : "SSID_000",
    "broadcast_name" : "SSID_000",
    "description" : "The WIFI SSID 0",
    "predefined" : false,
    "advanced_settings_id" : 438086764331,
    "enable_user_profile_assignment" : false,
    "enable_radius_attribute_user_profile_assignment" : false,
    "attribute_key" : 0,
    "access_security" : {
      "key_value" : "",
      "anti_logging_threshold" : 0,
      "transition_mode" : false,
      "security_type" : ""
    },
    "radius_client_profile" : {
      "default_radius_client_object_id" : 0,
      "enable_classification" : false,
      "classified_entries" : [ ]
    },
    "default_user_profile" : 0,
    "vendor_id" : 0,
    "user_profile_assignment_rules" : [ ]
  }, {
    "id" : 11,
    "create_time" : "2024-04-03T19:55:18.000+0000",
    "update_time" : "2024-04-03T19:55:18.000+0000",
    "org_id" : 0,
    "name" : "SSID_001",
    "broadcast_name" : "SSID_001",
    "description" : "The WIFI SSID 1",
    "predefined" : false,
    "advanced_settings_id" : 438086764332,
    "enable_user_profile_assignment" : false,
    "enable_radius_attribute_user_profile_assignment" : false,
    "attribute_key" : 0,
    "access_security" : {
      "key_value" : "",
      "anti_logging_threshold" : 0,
      "transition_mode" : false,
      "security_type" : ""
    },
    "radius_client_profile" : {
      "default_radius_client_object_id" : 0,
      "enable_classification" : false,
      "classified_entries" : [ ]
    },
    "default_user_profile" : 0,
    "vendor_id" : 0,
    "user_profile_assignment_rules" : [ ]
  } ]
}

cURL Request

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

Rename SSID

POST /ssids/{id}/:rename

Path Parameters

Table 100. /ssids/{id}/:rename
Parameter	Description
`id`	The SSID ID.

HTTP Request

POST /ssids/438086664193/:rename HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDExOSwiZXhwIjoxNzEyNzc4OTE5fQ.dsv3xGuOZ0HWJQ8uFcZ0mbF5Qab7N_BXWyBWav6U0GU
Content-Type: application/json
Content-Length: 12

"'NEW 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
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
RateLimit-Remaining: 7471

cURL Request

$ curl 'https://api.extremecloudiq.com/ssids/438086664193/:rename' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDExOSwiZXhwIjoxNzEyNzc4OTE5fQ.dsv3xGuOZ0HWJQ8uFcZ0mbF5Qab7N_BXWyBWav6U0GU' \
    -H 'Content-Type: application/json' \
    -d '"'NEW NAME'"'

Attach CWP to an SSID

POST /ssids/{id}/cwp/:attach

Path Parameters

Table 101. /ssids/{id}/cwp/:attach
Parameter	Description
`id`	The SSID ID.

HTTP Request

POST /ssids/438086664193/cwp/:attach HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDExOSwiZXhwIjoxNzEyNzc4OTE5fQ.dsv3xGuOZ0HWJQ8uFcZ0mbF5Qab7N_BXWyBWav6U0GU
Content-Type: application/json
Content-Length: 12

438086664193

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: 7472

cURL Request

$ curl 'https://api.extremecloudiq.com/ssids/438086664193/cwp/:attach' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDExOSwiZXhwIjoxNzEyNzc4OTE5fQ.dsv3xGuOZ0HWJQ8uFcZ0mbF5Qab7N_BXWyBWav6U0GU' \
    -H 'Content-Type: application/json' \
    -d '438086664193'

Disable and detach CWP on SSID

POST /ssids/{id}/cwp/:disable

Path Parameters

Table 102. /ssids/{id}/cwp/:disable
Parameter	Description
`id`	The SSID ID.

HTTP Request

POST /ssids/438086664193/cwp/:disable HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDExOSwiZXhwIjoxNzEyNzc4OTE5fQ.dsv3xGuOZ0HWJQ8uFcZ0mbF5Qab7N_BXWyBWav6U0GU

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: 7467
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/ssids/438086664193/cwp/:disable' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDExOSwiZXhwIjoxNzEyNzc4OTE5fQ.dsv3xGuOZ0HWJQ8uFcZ0mbF5Qab7N_BXWyBWav6U0GU'

Enable and attach CWP on SSID

POST /ssids/{id}/cwp/:enable

Path Parameters

Table 103. /ssids/{id}/cwp/:enable
Parameter	Description
`id`	The SSID ID.

HTTP Request

POST /ssids/438086664193/cwp/:enable HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Content-Length: 12
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDExOCwiZXhwIjoxNzEyNzc4OTE4fQ.Zdnlq8Ae49SN5UL_QCA_ME1r0zPufxiaaJF3WsWiclI

438086664193

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Remaining: 7475
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/ssids/438086664193/cwp/:enable' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDExOCwiZXhwIjoxNzEyNzc4OTE4fQ.Zdnlq8Ae49SN5UL_QCA_ME1r0zPufxiaaJF3WsWiclI' \
    -d '438086664193'

Set SSID mode to Dot1x

PUT /ssids/{id}/mode/dot1x

Path Parameters

Table 104. /ssids/{id}/mode/dot1x
Parameter	Description
`id`	The SSID ID

Request Fields

Path Type Description

key_management

String

The key management: WPA_8021X, WPA2_8021X, WPA3_8021X or AUTO_8021X

encryption_method

String

The encryption method: for WPA_8021X, WPA2_8021X, please use CCMP or TKIP, for AUTO_8021X, please use AUTO_TKIP_CCMP, for WPA3_8021X, please use AES192

enable_idm

Boolean

Flag for using ExtremeCloud IQ Authentication Service or not

user_group_ids

Array

The user group ids to be attached to the SSID if using ExtremeCloud IQ Authentication Service

transition_mode

Boolean

Flag for enabling transition mode if using WPA3 as the key management type.

radius_server_group_id

Number

The RADIUS server group ID if not using ExtremeCloud IQ Authentication Service

enable_uztna

Boolean

Flag for enable uztna

HTTP Request

PUT /ssids/438086664193/mode/dot1x HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDExOSwiZXhwIjoxNzEyNzc4OTE5fQ.dsv3xGuOZ0HWJQ8uFcZ0mbF5Qab7N_BXWyBWav6U0GU
Content-Type: application/json
Content-Length: 212

{
  "key_management" : "WPA3_8021X",
  "encryption_method" : "CCMP",
  "enable_idm" : false,
  "transition_mode" : true,
  "radius_server_group_id" : 1,
  "user_group_ids" : [ 1, 2, 3 ],
  "enable_uztna" : true
}

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: 7468
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/ssids/438086664193/mode/dot1x' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDExOSwiZXhwIjoxNzEyNzc4OTE5fQ.dsv3xGuOZ0HWJQ8uFcZ0mbF5Qab7N_BXWyBWav6U0GU' \
    -H 'Content-Type: application/json' \
    -d '{
  "key_management" : "WPA3_8021X",
  "encryption_method" : "CCMP",
  "enable_idm" : false,
  "transition_mode" : true,
  "radius_server_group_id" : 1,
  "user_group_ids" : [ 1, 2, 3 ],
  "enable_uztna" : true
}'

Set SSID mode to open access

PUT /ssids/{id}/mode/open

Path Parameters

Table 105. /ssids/{id}/mode/open
Parameter	Description
`id`	The SSID ID

HTTP Request

PUT /ssids/438086664193/mode/open HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDExOCwiZXhwIjoxNzEyNzc4OTE4fQ.Zdnlq8Ae49SN5UL_QCA_ME1r0zPufxiaaJF3WsWiclI

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
RateLimit-Remaining: 7477
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/ssids/438086664193/mode/open' -i -X PUT \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDExOCwiZXhwIjoxNzEyNzc4OTE4fQ.Zdnlq8Ae49SN5UL_QCA_ME1r0zPufxiaaJF3WsWiclI'

Set SSID mode to PPSK

PUT /ssids/{id}/mode/ppsk

Path Parameters

Table 106. /ssids/{id}/mode/ppsk
Parameter	Description
`id`	The SSID ID

Request Fields

Path Type Description

key_management

String

The key management: WPA2_PSK, WPA_PSK,AUTO_PSK

encryption_method

String

The encryption method: for WPA2_PSK or WPA_PSK, please use CCMP or TKIP, for AUTO_PSK, please use AUTO_TKIP_CCMP

user_group_ids

Array

The user group ids to be attached to the SSID

enable_max_clients_per_ppsk

Boolean

Flag for enabling the max clients per PPSK

max_clients_per_ppsk

Number

The max clients (0-15) per PPSK if enabled enable_max_clients_per_ppsk flag, 0 means unlimited

enable_mac_bind

Boolean

Flag for enabling mac binding or not. This setting is only supported with local PPSK.

max_macs_per_ppsk

Number

Set the max MAC binding numbers per private PSK, Min:1, Max:5

ppsk_server_id

Number

The PPSK server device ID if enabled mac bind

HTTP Request

PUT /ssids/438086664193/mode/ppsk HTTP/1.1
Content-Length: 251
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDExOSwiZXhwIjoxNzEyNzc4OTE5fQ.dsv3xGuOZ0HWJQ8uFcZ0mbF5Qab7N_BXWyBWav6U0GU
Content-Type: application/json

{
  "key_management" : "WPA2_PSK",
  "encryption_method" : "CCMP",
  "user_group_ids" : [ 1, 2, 3 ],
  "enable_max_clients_per_ppsk" : true,
  "max_clients_per_ppsk" : 10,
  "enable_mac_bind" : true,
  "max_macs_per_ppsk" : 1,
  "ppsk_server_id" : 2
}

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: 7470

cURL Request

$ curl 'https://api.extremecloudiq.com/ssids/438086664193/mode/ppsk' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDExOSwiZXhwIjoxNzEyNzc4OTE5fQ.dsv3xGuOZ0HWJQ8uFcZ0mbF5Qab7N_BXWyBWav6U0GU' \
    -H 'Content-Type: application/json' \
    -d '{
  "key_management" : "WPA2_PSK",
  "encryption_method" : "CCMP",
  "user_group_ids" : [ 1, 2, 3 ],
  "enable_max_clients_per_ppsk" : true,
  "max_clients_per_ppsk" : 10,
  "enable_mac_bind" : true,
  "max_macs_per_ppsk" : 1,
  "ppsk_server_id" : 2
}'

Set SSID mode to PSK

PUT /ssids/{id}/mode/psk

Path Parameters

Table 107. /ssids/{id}/mode/psk
Parameter	Description
`id`	The SSID ID

Request Fields

Path Type Description

key_management

String

The key management: WPA3_PSK, WPA2_PSK, WPA_PSK,AUTO_PSK

encryption_method

String

The encryption method: for WPA3_PSK please use CCMP, for WPA2_PSK or WPA_PSK, please use CCMP or TKIP, for AUTO_PSK, please use AUTO_TKIP_CCMP

anti_logging_threshold

Number

The anti logging threshold for WPA3_PSK, 2-64

key_type

String

The PSK key type, ASCII or HEX

key_value

String

The PSK key value, minimum 8 characters long

sae_group

String

The SAE group: ALL, ECC, or FFC, must be selected when the key management is WPA3

transition_mode

Boolean

Indicates the transition mode if key management is WPA3

HTTP Request

PUT /ssids/438086664193/mode/psk HTTP/1.1
Host: api.extremecloudiq.com
Content-Length: 119
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDExOSwiZXhwIjoxNzEyNzc4OTE5fQ.dsv3xGuOZ0HWJQ8uFcZ0mbF5Qab7N_BXWyBWav6U0GU
Content-Type: application/json

{
  "key_management" : "WPA2_PSK",
  "encryption_method" : "CCMP",
  "key_type" : "ASCII",
  "key_value" : "BKxtQ7O7"
}

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
RateLimit-Remaining: 7466
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/ssids/438086664193/mode/psk' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDExOSwiZXhwIjoxNzEyNzc4OTE5fQ.dsv3xGuOZ0HWJQ8uFcZ0mbF5Qab7N_BXWyBWav6U0GU' \
    -H 'Content-Type: application/json' \
    -d '{
  "key_management" : "WPA2_PSK",
  "encryption_method" : "CCMP",
  "key_type" : "ASCII",
  "key_value" : "BKxtQ7O7"
}'

Set SSID mode to WEP

PUT /ssids/{id}/mode/wep

Path Parameters

Table 108. /ssids/{id}/mode/wep
Parameter	Description
`id`	The SSID ID

Request Fields

Path Type Description

key_management

String

The key management type, WEP or WEP802_1X

encryption_method

String

The encryption method type, WEP104 or WEP40

authentication_method

String

The authentication method type, OPEN or SHARED

default_key

String

The default key: FIRST, SECOND,THIRD, OR FOURTH

key_type

String

The key type, ASCII or HEX

key_value

String

The first key value, must be 13 characters long for WEP104, and 5 characters long for WEP40 and cannot be null if the default key is the first key

key_value2

String

The second key value, must be 13 characters long for WEP104, and 5 characters long for WEP40 and cannot be null if the default key is the second key

key_value3

String

The third key value, must be 13 characters long for WEP104, and 5 characters long for WEP40 and cannot be null if the default key is the third key

key_value4

String

The fourth key value, must be 13 characters long for WEP104, and 5 characters long for WEP40 and cannot be null if the default key is the fourth key

radius_server_group_id

Number

The RADIUS server group ID if using WEP802_1x as the key management

HTTP Request

PUT /ssids/438086664193/mode/wep HTTP/1.1
Content-Length: 251
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDExOSwiZXhwIjoxNzEyNzc4OTE5fQ.dsv3xGuOZ0HWJQ8uFcZ0mbF5Qab7N_BXWyBWav6U0GU
Content-Type: application/json

{
  "key_management" : "WEP",
  "encryption_method" : "WEP40",
  "authentication_method" : "OPEN",
  "default_key" : "FIRST",
  "key_type" : "ASCII",
  "key_value" : "U6CLUvRtVVdSA",
  "key_value2" : "ElVcOz0ftAErq",
  "key_value3" : "ocZDAZTi7J1er"
}

HTTP Response

HTTP/1.1 200 OK
RateLimit-Remaining: 7473
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/ssids/438086664193/mode/wep' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDExOSwiZXhwIjoxNzEyNzc4OTE5fQ.dsv3xGuOZ0HWJQ8uFcZ0mbF5Qab7N_BXWyBWav6U0GU' \
    -H 'Content-Type: application/json' \
    -d '{
  "key_management" : "WEP",
  "encryption_method" : "WEP40",
  "authentication_method" : "OPEN",
  "default_key" : "FIRST",
  "key_type" : "ASCII",
  "key_value" : "U6CLUvRtVVdSA",
  "key_value2" : "ElVcOz0ftAErq",
  "key_value3" : "ocZDAZTi7J1er"
}'

Change SSID PSK password

PUT /ssids/{id}/psk/password

Path Parameters

Table 109. /ssids/{id}/psk/password
Parameter	Description
`id`	The SSID ID.

HTTP Request

PUT /ssids/438086664193/psk/password HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDExOSwiZXhwIjoxNzEyNzc4OTE5fQ.dsv3xGuOZ0HWJQ8uFcZ0mbF5Qab7N_BXWyBWav6U0GU
Content-Type: application/json
Content-Length: 14

"'BKxtQ7O7WV'"

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: 7467
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/ssids/438086664193/psk/password' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDExOSwiZXhwIjoxNzEyNzc4OTE5fQ.dsv3xGuOZ0HWJQ8uFcZ0mbF5Qab7N_BXWyBWav6U0GU' \
    -H 'Content-Type: application/json' \
    -d '"'BKxtQ7O7WV'"'

Attach radius server group to an SSID

POST /ssids/{id}/radius-server-group/:attach

Path parameters

Table 110. /ssids/{id}/radius-server-group/:attach
Parameter	Description
`id`	The SSID ID.

HTTP Request

POST /ssids/438086664193/radius-server-group/:attach HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Content-Length: 12
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDExOCwiZXhwIjoxNzEyNzc4OTE4fQ.Zdnlq8Ae49SN5UL_QCA_ME1r0zPufxiaaJF3WsWiclI

438086664193

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: 7478
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/ssids/438086664193/radius-server-group/:attach' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDExOCwiZXhwIjoxNzEyNzc4OTE4fQ.Zdnlq8Ae49SN5UL_QCA_ME1r0zPufxiaaJF3WsWiclI' \
    -d '438086664193'

Attach user profile to an SSID

POST /ssids/{id}/user-profile/:attach

Path parameters

Table 111. /ssids/{id}/user-profile/:attach
Parameter	Description
`id`	The SSID ID.

HTTP Request

POST /ssids/438086664193/user-profile/:attach HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDExOSwiZXhwIjoxNzEyNzc4OTE5fQ.dsv3xGuOZ0HWJQ8uFcZ0mbF5Qab7N_BXWyBWav6U0GU
Content-Type: application/json
Content-Length: 12

438086664193

HTTP Response

HTTP/1.1 200 OK
RateLimit-Remaining: 7473
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/ssids/438086664193/user-profile/:attach' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDExOSwiZXhwIjoxNzEyNzc4OTE5fQ.dsv3xGuOZ0HWJQ8uFcZ0mbF5Qab7N_BXWyBWav6U0GU' \
    -H 'Content-Type: application/json' \
    -d '438086664193'

Get SSID advanced settings by ID

GET /ssids/advanced-settings/{id}

Path Parameters

Table 112. /ssids/advanced-settings/{id}
Parameter	Description
`id`	The SSID advanced settings ID.

HTTP Request

GET /ssids/advanced-settings/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDExOSwiZXhwIjoxNzEyNzc4OTE5fQ.dsv3xGuOZ0HWJQ8uFcZ0mbF5Qab7N_BXWyBWav6U0GU
Content-Type: application/json

Response Fields

Path Type Description

id

Number

The SSID advanced settings ID.

create_time

String

The create time

update_time

String

The last update time

enable802_dot11mc

Boolean

Whether to enable 802.11mc.

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: 7469
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: 155

{
  "id" : 438086764333,
  "create_time" : "2024-04-03T19:55:19.000+0000",
  "update_time" : "2024-04-03T19:55:19.000+0000",
  "enable802_dot11mc" : true
}

cURL Request

$ curl 'https://api.extremecloudiq.com/ssids/advanced-settings/438086664193' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDExOSwiZXhwIjoxNzEyNzc4OTE5fQ.dsv3xGuOZ0HWJQ8uFcZ0mbF5Qab7N_BXWyBWav6U0GU' \
    -H 'Content-Type: application/json'

Update SSID advanced settings by ID

PUT /ssids/advanced-settings/{id}

Path Parameters

Table 113. /ssids/advanced-settings/{id}
Parameter	Description
`id`	SSID advanced settings ID

Request Fields

Path Type Description

enable802_dot11mc

Boolean

Whether to enable 802.11mc.

HTTP Request

PUT /ssids/advanced-settings/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Content-Length: 32
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDExOCwiZXhwIjoxNzEyNzc4OTE4fQ.Zdnlq8Ae49SN5UL_QCA_ME1r0zPufxiaaJF3WsWiclI

{
  "enable802_dot11mc" : true
}

Response Fields

Path Type Description

id

Number

The SSID advanced settings ID.

create_time

String

The create time

update_time

String

The last update time

enable802_dot11mc

Boolean

Whether to enable 802.11mc.

HTTP Response

HTTP/1.1 200 OK
RateLimit-Remaining: 7474
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: 155

{
  "id" : 438086764333,
  "create_time" : "2024-04-03T19:55:18.000+0000",
  "update_time" : "2024-04-03T19:55:18.000+0000",
  "enable802_dot11mc" : true
}

cURL Request

$ curl 'https://api.extremecloudiq.com/ssids/advanced-settings/438086664193' -i -X PUT \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDExOCwiZXhwIjoxNzEyNzc4OTE4fQ.Zdnlq8Ae49SN5UL_QCA_ME1r0zPufxiaaJF3WsWiclI' \
    -d '{
  "enable802_dot11mc" : true
}'

List user profiles

GET /user-profiles

Request Parameters

Parameter Description

page

Page number

limit

Page size

HTTP Request

GET /user-profiles?page=1&limit=10 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyMCwiZXhwIjoxNzEyNzc4OTIwfQ.fCVc8nbykfMD0tzQNEGaby8Nbap_Rh_GskiJOghuxJ4
Host: api.extremecloudiq.com
Content-Type: application/json

Response Fields

Path Type Description

page

Number

The current page number.

count

Number

The element count of the current page.

total_pages

Number

The total page number based on request page size.

total_count

Number

The total element count.

data[].id

Number

The user profile ID.

data[].name

String

The user profile name.

data[].create_time

String

The create time of user profile.

data[].update_time

String

The update time of user profile.

data[].vlan_profile.id

Number

The vlan profile ID.

data[].vlan_profile.org_id

Number

The vlan profile org ID.

data[].vlan_profile.create_time

String

The create time.

data[].vlan_profile.update_time

String

The last update time.

data[].vlan_profile.name

String

The name of vlan profile.

data[].vlan_profile.default_vlan_id

Number

The default vlan ID.

data[].vlan_profile.enable_classification

Boolean

Apply VLANs to devices using classification.

data[].vlan_profile.classified_entries[].id

Number

The classified entry ID.

data[].vlan_profile.classified_entries[].org_id

Number

The classified entry org ID.

data[].vlan_profile.classified_entries[].create_time

String

The create time.

data[].vlan_profile.classified_entries[].update_time

String

The last update time.

data[].vlan_profile.classified_entries[].vlan_id

Number

The vlan ID.

data[].vlan_profile.classified_entries[].classification_rule.id

Number

The classification assignment id.

data[].vlan_profile.classified_entries[].classification_rule.org_id

Number

The classification assignment org id.

data[].vlan_profile.classified_entries[].classification_rule.name

String

The classification assignment name.

data[].vlan_profile.classified_entries[].classification_rule.description

String

The classification assignment description.

data[].vlan_profile.classified_entries[].classification_rule.create_time

String

The classification assignment create time.

data[].vlan_profile.classified_entries[].classification_rule.update_time

String

The classification assignment update time.

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

Number

The classification id.

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

Boolean

Match or not match with classification.

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

String

The value of classification.

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

String

The create time.

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

String

The last update time.

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

String

The classification type.

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

Number

The classification reference ID.

HTTP Response

HTTP/1.1 200 OK
RateLimit-Remaining: 7462
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Content-Length: 14317
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

{
  "page" : 1,
  "count" : 0,
  "total_pages" : 0,
  "total_count" : 0,
  "data" : [ {
    "id" : 0,
    "create_time" : "1970-01-01T00:00:00.000+0000",
    "update_time" : "1970-01-01T00:00:00.000+0000",
    "name" : "User_profile_0",
    "vlan_profile" : {
      "id" : 0,
      "create_time" : "1970-01-01T00:00:00.000+0000",
      "update_time" : "1970-01-01T00:00:00.000+0000",
      "org_id" : 0,
      "name" : "VLAN_profile_0",
      "default_vlan_id" : 0,
      "enable_classification" : false,
      "classified_entries" : [ {
        "id" : 0,
        "create_time" : "1970-01-01T00:00:00.000+0000",
        "update_time" : "1970-01-01T00:00:00.000+0000",
        "org_id" : 0,
        "vlan_id" : 0,
        "classification_rule" : {
          "id" : 1,
          "create_time" : "2024-04-03T19:55:20.000+0000",
          "update_time" : "2024-04-03T19:55:20.000+0000",
          "org_id" : 0,
          "name" : "10.0.0.1",
          "description" : "IP classification assignment",
          "classifications" : [ {
            "id" : 0,
            "create_time" : "1970-01-01T00:00:00.000+0000",
            "update_time" : "1970-01-01T00:00:00.000+0000",
            "classification_type" : "IP_ADDRESS",
            "match" : true,
            "classification_id" : 1,
            "value" : "10.0.0.1"
          }, {
            "id" : 1,
            "create_time" : "1970-01-01T00:00:00.000+0000",
            "update_time" : "1970-01-01T00:00:00.000+0000",
            "classification_type" : "IP_ADDRESS",
            "match" : true,
            "classification_id" : 1,
            "value" : "10.0.0.1"
          }, {
            "id" : 2,
            "create_time" : "1970-01-01T00:00:00.000+0000",
            "update_time" : "1970-01-01T00:00:00.000+0000",
            "classification_type" : "IP_ADDRESS",
            "match" : true,
            "classification_id" : 1,
            "value" : "10.0.0.1"
          } ]
        }
      }, {
        "id" : 1,
        "create_time" : "1970-01-01T00:00:00.000+0000",
        "update_time" : "1970-01-01T00:00:00.000+0000",
        "org_id" : 0,
        "vlan_id" : 1,
        "classification_rule" : {
          "id" : 1,
          "create_time" : "2024-04-03T19:55:20.000+0000",
          "update_time" : "2024-04-03T19:55:20.000+0000",
          "org_id" : 0,
          "name" : "10.0.0.1",
          "description" : "IP classification assignment",
          "classifications" : [ {
            "id" : 0,
            "create_time" : "1970-01-01T00:00:00.000+0000",
            "update_time" : "1970-01-01T00:00:00.000+0000",
            "classification_type" : "IP_ADDRESS",
            "match" : true,
            "classification_id" : 1,
            "value" : "10.0.0.1"
          }, {
            "id" : 1,
            "create_time" : "1970-01-01T00:00:00.000+0000",
            "update_time" : "1970-01-01T00:00:00.000+0000",
            "classification_type" : "IP_ADDRESS",
            "match" : true,
            "classification_id" : 1,
            "value" : "10.0.0.1"
          }, {
            "id" : 2,
            "create_time" : "1970-01-01T00:00:00.000+0000",
            "update_time" : "1970-01-01T00:00:00.000+0000",
            "classification_type" : "IP_ADDRESS",
            "match" : true,
            "classification_id" : 1,
            "value" : "10.0.0.1"
          } ]
        }
      }, {
        "id" : 2,
        "create_time" : "1970-01-01T00:00:00.000+0000",
        "update_time" : "1970-01-01T00:00:00.000+0000",
        "org_id" : 0,
        "vlan_id" : 2,
        "classification_rule" : {
          "id" : 1,
          "create_time" : "2024-04-03T19:55:20.000+0000",
          "update_time" : "2024-04-03T19:55:20.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",
    "name" : "User_profile_1",
    "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_1",
      "default_vlan_id" : 0,
      "enable_classification" : false,
      "classified_entries" : [ {
        "id" : 0,
        "create_time" : "1970-01-01T00:00:00.000+0000",
        "update_time" : "1970-01-01T00:00:00.000+0000",
        "org_id" : 0,
        "vlan_id" : 0,
        "classification_rule" : {
          "id" : 1,
          "create_time" : "2024-04-03T19:55:20.000+0000",
          "update_time" : "2024-04-03T19:55:20.000+0000",
          "org_id" : 0,
          "name" : "10.0.0.1",
          "description" : "IP classification assignment",
          "classifications" : [ {
            "id" : 0,
            "create_time" : "1970-01-01T00:00:00.000+0000",
            "update_time" : "1970-01-01T00:00:00.000+0000",
            "classification_type" : "IP_ADDRESS",
            "match" : true,
            "classification_id" : 1,
            "value" : "10.0.0.1"
          }, {
            "id" : 1,
            "create_time" : "1970-01-01T00:00:00.000+0000",
            "update_time" : "1970-01-01T00:00:00.000+0000",
            "classification_type" : "IP_ADDRESS",
            "match" : true,
            "classification_id" : 1,
            "value" : "10.0.0.1"
          }, {
            "id" : 2,
            "create_time" : "1970-01-01T00:00:00.000+0000",
            "update_time" : "1970-01-01T00:00:00.000+0000",
            "classification_type" : "IP_ADDRESS",
            "match" : true,
            "classification_id" : 1,
            "value" : "10.0.0.1"
          } ]
        }
      }, {
        "id" : 1,
        "create_time" : "1970-01-01T00:00:00.000+0000",
        "update_time" : "1970-01-01T00:00:00.000+0000",
        "org_id" : 0,
        "vlan_id" : 1,
        "classification_rule" : {
          "id" : 1,
          "create_time" : "2024-04-03T19:55:20.000+0000",
          "update_time" : "2024-04-03T19:55:20.000+0000",
          "org_id" : 0,
          "name" : "10.0.0.1",
          "description" : "IP classification assignment",
          "classifications" : [ {
            "id" : 0,
            "create_time" : "1970-01-01T00:00:00.000+0000",
            "update_time" : "1970-01-01T00:00:00.000+0000",
            "classification_type" : "IP_ADDRESS",
            "match" : true,
            "classification_id" : 1,
            "value" : "10.0.0.1"
          }, {
            "id" : 1,
            "create_time" : "1970-01-01T00:00:00.000+0000",
            "update_time" : "1970-01-01T00:00:00.000+0000",
            "classification_type" : "IP_ADDRESS",
            "match" : true,
            "classification_id" : 1,
            "value" : "10.0.0.1"
          }, {
            "id" : 2,
            "create_time" : "1970-01-01T00:00:00.000+0000",
            "update_time" : "1970-01-01T00:00:00.000+0000",
            "classification_type" : "IP_ADDRESS",
            "match" : true,
            "classification_id" : 1,
            "value" : "10.0.0.1"
          } ]
        }
      }, {
        "id" : 2,
        "create_time" : "1970-01-01T00:00:00.000+0000",
        "update_time" : "1970-01-01T00:00:00.000+0000",
        "org_id" : 0,
        "vlan_id" : 2,
        "classification_rule" : {
          "id" : 1,
          "create_time" : "2024-04-03T19:55:20.000+0000",
          "update_time" : "2024-04-03T19:55:20.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",
    "name" : "User_profile_2",
    "vlan_profile" : {
      "id" : 2,
      "create_time" : "1970-01-01T00:00:00.000+0000",
      "update_time" : "1970-01-01T00:00:00.000+0000",
      "org_id" : 0,
      "name" : "VLAN_profile_2",
      "default_vlan_id" : 0,
      "enable_classification" : false,
      "classified_entries" : [ {
        "id" : 0,
        "create_time" : "1970-01-01T00:00:00.000+0000",
        "update_time" : "1970-01-01T00:00:00.000+0000",
        "org_id" : 0,
        "vlan_id" : 0,
        "classification_rule" : {
          "id" : 1,
          "create_time" : "2024-04-03T19:55:20.000+0000",
          "update_time" : "2024-04-03T19:55:20.000+0000",
          "org_id" : 0,
          "name" : "10.0.0.1",
          "description" : "IP classification assignment",
          "classifications" : [ {
            "id" : 0,
            "create_time" : "1970-01-01T00:00:00.000+0000",
            "update_time" : "1970-01-01T00:00:00.000+0000",
            "classification_type" : "IP_ADDRESS",
            "match" : true,
            "classification_id" : 1,
            "value" : "10.0.0.1"
          }, {
            "id" : 1,
            "create_time" : "1970-01-01T00:00:00.000+0000",
            "update_time" : "1970-01-01T00:00:00.000+0000",
            "classification_type" : "IP_ADDRESS",
            "match" : true,
            "classification_id" : 1,
            "value" : "10.0.0.1"
          }, {
            "id" : 2,
            "create_time" : "1970-01-01T00:00:00.000+0000",
            "update_time" : "1970-01-01T00:00:00.000+0000",
            "classification_type" : "IP_ADDRESS",
            "match" : true,
            "classification_id" : 1,
            "value" : "10.0.0.1"
          } ]
        }
      }, {
        "id" : 1,
        "create_time" : "1970-01-01T00:00:00.000+0000",
        "update_time" : "1970-01-01T00:00:00.000+0000",
        "org_id" : 0,
        "vlan_id" : 1,
        "classification_rule" : {
          "id" : 1,
          "create_time" : "2024-04-03T19:55:20.000+0000",
          "update_time" : "2024-04-03T19:55:20.000+0000",
          "org_id" : 0,
          "name" : "10.0.0.1",
          "description" : "IP classification assignment",
          "classifications" : [ {
            "id" : 0,
            "create_time" : "1970-01-01T00:00:00.000+0000",
            "update_time" : "1970-01-01T00:00:00.000+0000",
            "classification_type" : "IP_ADDRESS",
            "match" : true,
            "classification_id" : 1,
            "value" : "10.0.0.1"
          }, {
            "id" : 1,
            "create_time" : "1970-01-01T00:00:00.000+0000",
            "update_time" : "1970-01-01T00:00:00.000+0000",
            "classification_type" : "IP_ADDRESS",
            "match" : true,
            "classification_id" : 1,
            "value" : "10.0.0.1"
          }, {
            "id" : 2,
            "create_time" : "1970-01-01T00:00:00.000+0000",
            "update_time" : "1970-01-01T00:00:00.000+0000",
            "classification_type" : "IP_ADDRESS",
            "match" : true,
            "classification_id" : 1,
            "value" : "10.0.0.1"
          } ]
        }
      }, {
        "id" : 2,
        "create_time" : "1970-01-01T00:00:00.000+0000",
        "update_time" : "1970-01-01T00:00:00.000+0000",
        "org_id" : 0,
        "vlan_id" : 2,
        "classification_rule" : {
          "id" : 1,
          "create_time" : "2024-04-03T19:55:20.000+0000",
          "update_time" : "2024-04-03T19:55:20.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?page=1&limit=10' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyMCwiZXhwIjoxNzEyNzc4OTIwfQ.fCVc8nbykfMD0tzQNEGaby8Nbap_Rh_GskiJOghuxJ4' \
    -H 'Content-Type: application/json'

Create user profile

POST /user-profiles

Request Fields

Path Type Description

name

String

The user profile name

vlan_profile_id

Number

The vlan profile id

HTTP Request

POST /user-profiles HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyMCwiZXhwIjoxNzEyNzc4OTIwfQ.fCVc8nbykfMD0tzQNEGaby8Nbap_Rh_GskiJOghuxJ4
Host: api.extremecloudiq.com
Content-Type: application/json
Content-Length: 57

{
  "name" : "test-co-vlan-01",
  "vlan_profile_id" : 1
}

Response Fields

Path Type Description

id

Number

The user profile ID.

name

String

The user profile name.

create_time

String

The create time of user profile.

update_time

String

The update time of user profile.

vlan_profile.id

Number

The vlan profile ID

vlan_profile.org_id

Number

The vlan profile org ID

vlan_profile.name

String

The vlan profile name

vlan_profile.create_time

String

The create time of vlan profile

vlan_profile.update_time

String

The update time of vlan profile

vlan_profile.default_vlan_id

Number

The default vlan ID

vlan_profile.enable_classification

Boolean

The enable classification name

vlan_profile.classified_entries[].id

Number

The classified entry ID

vlan_profile.classified_entries[].org_id

Number

The classified entry org ID

vlan_profile.classified_entries[].create_time

String

The create time

vlan_profile.classified_entries[].update_time

String

The update time

vlan_profile.classified_entries[].vlan_id

Number

The vlan ID

vlan_profile.classified_entries[].classification_rule.id

Number

The classification assignment ID

vlan_profile.classified_entries[].classification_rule.org_id

Number

The classification assignment org ID

vlan_profile.classified_entries[].classification_rule.name

String

The classification assignment name

vlan_profile.classified_entries[].classification_rule.description

String

The classification assignment description

vlan_profile.classified_entries[].classification_rule.create_time

String

The create time of classification assignment

vlan_profile.classified_entries[].classification_rule.update_time

String

The update time of classification assignment

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

Number

The classification ID

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

Boolean

The match type of classification

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

String

The value of classification

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

String

The create time of classification

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

String

The update time of classification

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

String

The classification type

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

Number

The classification reference ID

HTTP Response

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

{
  "id" : 1,
  "create_time" : "1970-01-01T00:00:00.000+0000",
  "update_time" : "1970-01-01T00:00:00.000+0000",
  "name" : "User_profile_",
  "vlan_profile" : {
    "id" : 1,
    "create_time" : "1970-01-01T00:00:00.000+0000",
    "update_time" : "1970-01-01T00:00:00.000+0000",
    "org_id" : 0,
    "name" : "VLAN_profile_",
    "default_vlan_id" : 0,
    "enable_classification" : false,
    "classified_entries" : [ {
      "id" : 0,
      "create_time" : "1970-01-01T00:00:00.000+0000",
      "update_time" : "1970-01-01T00:00:00.000+0000",
      "org_id" : 0,
      "vlan_id" : 0,
      "classification_rule" : {
        "id" : 1,
        "create_time" : "2024-04-03T19:55:20.000+0000",
        "update_time" : "2024-04-03T19:55:20.000+0000",
        "org_id" : 0,
        "name" : "10.0.0.1",
        "description" : "IP classification assignment",
        "classifications" : [ {
          "id" : 0,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        }, {
          "id" : 1,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        }, {
          "id" : 2,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        } ]
      }
    }, {
      "id" : 1,
      "create_time" : "1970-01-01T00:00:00.000+0000",
      "update_time" : "1970-01-01T00:00:00.000+0000",
      "org_id" : 0,
      "vlan_id" : 1,
      "classification_rule" : {
        "id" : 1,
        "create_time" : "2024-04-03T19:55:20.000+0000",
        "update_time" : "2024-04-03T19:55:20.000+0000",
        "org_id" : 0,
        "name" : "10.0.0.1",
        "description" : "IP classification assignment",
        "classifications" : [ {
          "id" : 0,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        }, {
          "id" : 1,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        }, {
          "id" : 2,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        } ]
      }
    }, {
      "id" : 2,
      "create_time" : "1970-01-01T00:00:00.000+0000",
      "update_time" : "1970-01-01T00:00:00.000+0000",
      "org_id" : 0,
      "vlan_id" : 2,
      "classification_rule" : {
        "id" : 1,
        "create_time" : "2024-04-03T19:55:20.000+0000",
        "update_time" : "2024-04-03T19:55:20.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' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyMCwiZXhwIjoxNzEyNzc4OTIwfQ.fCVc8nbykfMD0tzQNEGaby8Nbap_Rh_GskiJOghuxJ4' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "test-co-vlan-01",
  "vlan_profile_id" : 1
}'

Get user profile

GET /user-profiles/{id}

Path Parameters

Table 114. /user-profiles/{id}
Parameter	Description
`id`	The user profile ID

HTTP Request

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

Response Fields

Path Type Description

id

Number

The user profile ID.

name

String

The user profile name.

create_time

String

The create time of user profile.

update_time

String

The update time of user profile.

vlan_profile.id

Number

The vlan profile ID.

vlan_profile.org_id

Number

The vlan profile org ID.

vlan_profile.create_time

String

The create time.

vlan_profile.update_time

String

The last update time.

vlan_profile.name

String

The vlan profile name

vlan_profile.default_vlan_id

Number

The default vlan ID.

vlan_profile.enable_classification

Boolean

Enable classification.

vlan_profile.classified_entries[].id

Number

The classification entry id.

vlan_profile.classified_entries[].org_id

Number

The classification entry org id.

vlan_profile.classified_entries[].create_time

String

The create time of classified entry.

vlan_profile.classified_entries[].update_time

String

The update time of classified entry.

vlan_profile.classified_entries[].vlan_id

Number

The vlan ID.

vlan_profile.classified_entries[].classification_rule.id

Number

The classification assignment ID.

vlan_profile.classified_entries[].classification_rule.org_id

Number

The classification assignment org ID.

vlan_profile.classified_entries[].classification_rule.name

String

The classification assignment name.

vlan_profile.classified_entries[].classification_rule.description

String

The classification assignment description.

vlan_profile.classified_entries[].classification_rule.create_time

String

The create time of classification assignment.

vlan_profile.classified_entries[].classification_rule.update_time

String

The update time of classification assignment.

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

Number

The classification ID.

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

Boolean

Match or not match with classifications.

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

String

The value of classification.

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

String

The create time of classification.

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

String

The update time of classification.

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

String

The classification type.

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

Number

The classification reference ID.

HTTP Response

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

{
  "id" : 1,
  "create_time" : "1970-01-01T00:00:00.000+0000",
  "update_time" : "1970-01-01T00:00:00.000+0000",
  "name" : "User_profile_",
  "vlan_profile" : {
    "id" : 1,
    "create_time" : "1970-01-01T00:00:00.000+0000",
    "update_time" : "1970-01-01T00:00:00.000+0000",
    "org_id" : 0,
    "name" : "VLAN_profile_",
    "default_vlan_id" : 0,
    "enable_classification" : false,
    "classified_entries" : [ {
      "id" : 0,
      "create_time" : "1970-01-01T00:00:00.000+0000",
      "update_time" : "1970-01-01T00:00:00.000+0000",
      "org_id" : 0,
      "vlan_id" : 0,
      "classification_rule" : {
        "id" : 1,
        "create_time" : "2024-04-03T19:55:20.000+0000",
        "update_time" : "2024-04-03T19:55:20.000+0000",
        "org_id" : 0,
        "name" : "10.0.0.1",
        "description" : "IP classification assignment",
        "classifications" : [ {
          "id" : 0,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        }, {
          "id" : 1,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        }, {
          "id" : 2,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        } ]
      }
    }, {
      "id" : 1,
      "create_time" : "1970-01-01T00:00:00.000+0000",
      "update_time" : "1970-01-01T00:00:00.000+0000",
      "org_id" : 0,
      "vlan_id" : 1,
      "classification_rule" : {
        "id" : 1,
        "create_time" : "2024-04-03T19:55:20.000+0000",
        "update_time" : "2024-04-03T19:55:20.000+0000",
        "org_id" : 0,
        "name" : "10.0.0.1",
        "description" : "IP classification assignment",
        "classifications" : [ {
          "id" : 0,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        }, {
          "id" : 1,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        }, {
          "id" : 2,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        } ]
      }
    }, {
      "id" : 2,
      "create_time" : "1970-01-01T00:00:00.000+0000",
      "update_time" : "1970-01-01T00:00:00.000+0000",
      "org_id" : 0,
      "vlan_id" : 2,
      "classification_rule" : {
        "id" : 1,
        "create_time" : "2024-04-03T19:55:20.000+0000",
        "update_time" : "2024-04-03T19:55:20.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 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyMCwiZXhwIjoxNzEyNzc4OTIwfQ.fCVc8nbykfMD0tzQNEGaby8Nbap_Rh_GskiJOghuxJ4' \
    -H 'Content-Type: application/json'

Update user profile

PUT /user-profiles/{id}

Path Parameters

Table 115. /user-profiles/{id}
Parameter	Description
`id`	The user profile ID

Request Fields

Path Type Description

name

String

The user profile name

vlan_profile_id

Number

The vlan profile id

HTTP Request

PUT /user-profiles/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyMCwiZXhwIjoxNzEyNzc4OTIwfQ.fCVc8nbykfMD0tzQNEGaby8Nbap_Rh_GskiJOghuxJ4
Host: api.extremecloudiq.com
Content-Type: application/json
Content-Length: 47

{
  "name" : "UP-01",
  "vlan_profile_id" : 1
}

Response Fields

Path Type Description

id

Number

The user profile ID.

name

String

The user profile name.

create_time

String

The create time of user profile.

update_time

String

The update time of user profile.

vlan_profile.id

Number

The vlan profile ID

vlan_profile.org_id

Number

The vlan profile ID

vlan_profile.name

String

The vlan profile name

vlan_profile.create_time

String

The create time of vlan profile

vlan_profile.update_time

String

The update time of vlan profile

vlan_profile.default_vlan_id

Number

The default vlan ID

vlan_profile.enable_classification

Boolean

The enable classification name

vlan_profile.classified_entries[].id

Number

The classified entry ID

vlan_profile.classified_entries[].org_id

Number

The classified entry org ID

vlan_profile.classified_entries[].create_time

String

The create time

vlan_profile.classified_entries[].update_time

String

The update time

vlan_profile.classified_entries[].vlan_id

Number

The vlan ID

vlan_profile.classified_entries[].classification_rule.id

Number

The classification assignment ID

vlan_profile.classified_entries[].classification_rule.org_id

Number

The classification assignment org ID

vlan_profile.classified_entries[].classification_rule.name

String

The classification assignment name

vlan_profile.classified_entries[].classification_rule.description

String

The classification assignment description

vlan_profile.classified_entries[].classification_rule.create_time

String

The create time of classification assignment

vlan_profile.classified_entries[].classification_rule.update_time

String

The update time of classification assignment

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

Number

The classification ID

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

Boolean

The match type of classification

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

String

The value of classification

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

String

The create time of classification

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

String

The update time of classification

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

String

The classification type

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

Number

The classification reference ID

HTTP Response

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

{
  "id" : 1,
  "create_time" : "1970-01-01T00:00:00.000+0000",
  "update_time" : "1970-01-01T00:00:00.000+0000",
  "name" : "User_profile_",
  "vlan_profile" : {
    "id" : 1,
    "create_time" : "1970-01-01T00:00:00.000+0000",
    "update_time" : "1970-01-01T00:00:00.000+0000",
    "org_id" : 0,
    "name" : "VLAN_profile_",
    "default_vlan_id" : 0,
    "enable_classification" : false,
    "classified_entries" : [ {
      "id" : 0,
      "create_time" : "1970-01-01T00:00:00.000+0000",
      "update_time" : "1970-01-01T00:00:00.000+0000",
      "org_id" : 0,
      "vlan_id" : 0,
      "classification_rule" : {
        "id" : 1,
        "create_time" : "2024-04-03T19:55:20.000+0000",
        "update_time" : "2024-04-03T19:55:20.000+0000",
        "org_id" : 0,
        "name" : "10.0.0.1",
        "description" : "IP classification assignment",
        "classifications" : [ {
          "id" : 0,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        }, {
          "id" : 1,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        }, {
          "id" : 2,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        } ]
      }
    }, {
      "id" : 1,
      "create_time" : "1970-01-01T00:00:00.000+0000",
      "update_time" : "1970-01-01T00:00:00.000+0000",
      "org_id" : 0,
      "vlan_id" : 1,
      "classification_rule" : {
        "id" : 1,
        "create_time" : "2024-04-03T19:55:20.000+0000",
        "update_time" : "2024-04-03T19:55:20.000+0000",
        "org_id" : 0,
        "name" : "10.0.0.1",
        "description" : "IP classification assignment",
        "classifications" : [ {
          "id" : 0,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        }, {
          "id" : 1,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        }, {
          "id" : 2,
          "create_time" : "1970-01-01T00:00:00.000+0000",
          "update_time" : "1970-01-01T00:00:00.000+0000",
          "classification_type" : "IP_ADDRESS",
          "match" : true,
          "classification_id" : 1,
          "value" : "10.0.0.1"
        } ]
      }
    }, {
      "id" : 2,
      "create_time" : "1970-01-01T00:00:00.000+0000",
      "update_time" : "1970-01-01T00:00:00.000+0000",
      "org_id" : 0,
      "vlan_id" : 2,
      "classification_rule" : {
        "id" : 1,
        "create_time" : "2024-04-03T19:55:20.000+0000",
        "update_time" : "2024-04-03T19:55:20.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 PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyMCwiZXhwIjoxNzEyNzc4OTIwfQ.fCVc8nbykfMD0tzQNEGaby8Nbap_Rh_GskiJOghuxJ4' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "UP-01",
  "vlan_profile_id" : 1
}'

Delete user profile

DELETE /user-profiles/{id}

Path Parameters

Table 116. /user-profiles/{id}
Parameter	Description
`id`	The user profile ID

HTTP Request

DELETE /user-profiles/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyMCwiZXhwIjoxNzEyNzc4OTIwfQ.fCVc8nbykfMD0tzQNEGaby8Nbap_Rh_GskiJOghuxJ4
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: 7459
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/user-profiles/438086664193' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyMCwiZXhwIjoxNzEyNzc4OTIwfQ.fCVc8nbykfMD0tzQNEGaby8Nbap_Rh_GskiJOghuxJ4' \
    -H 'Content-Type: application/json'

List the IoT Profiles

GET /iot-profiles

Request Parameters

Parameter Description

page

Page number

limit

Page size

HTTP Request

GET /iot-profiles?page=1&limit=10 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyMiwiZXhwIjoxNzEyNzc4OTIyfQ.txcbPw5NR3qusFkyWtlasQ91DkW6xlBfRIlBsb7AwBg
Content-Type: application/json

Response Fields

Path Type Description

page

Number

The current page number.

count

Number

The element count of the current page.

total_pages

Number

The total page number based on request page size.

total_count

Number

The total element count.

data[].id

Number

The iot profile ID.

data[].name

String

The iot profile name.

data[].create_time

String

The create time of the iot profile.

data[].update_time

String

The update time of the iot profile.

data[].app_id

String

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

data[].thread_gateway

Object

When app_id = THREAD_GATEWAY provides definition of thread gateway.

data[].thread_gateway.short_pan_id

String

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

data[].thread_gateway.ext_pan_id

String

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

data[].thread_gateway.master_key

String

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

data[].thread_gateway.network_name

String

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

data[].thread_gateway.channel

Number

802.15.4 channel number, 11-26

data[].thread_gateway.comm_credentials

String

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

data[].thread_gateway.comm_timeout

Number

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

data[].thread_gateway.enable_nat64

Boolean

Enable NAT64 functions including the translator and the prefix publishing.

data[].thread_gateway.white_list

Array

The table of approved Thread end-devices.

data[].thread_gateway.white_list[].long_eui

String

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

data[].thread_gateway.white_list[].pskd

String

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

data[].thread_gateway.default_user_profile_id

Number

The default user-profile ID.

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Remaining: 7442
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: 1789

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 1,
  "total_count" : 2,
  "data" : [ {
    "id" : 1,
    "create_time" : "2024-04-03T19:55:22.000+0000",
    "update_time" : "2024-04-03T19:55:22.000+0000",
    "name" : "iot-profile-1",
    "app_id" : "THREAD_GATEWAY",
    "thread_gateway" : {
      "short_pan_id" : "a588",
      "ext_pan_id" : "12380b9943cd03ad",
      "master_key" : "47ab5d2cda236c83dd2131c3c8311c8a",
      "network_name" : "thread-network-1",
      "channel" : 15,
      "comm_credentials" : "3f8e463fe8b0be6f96d0cd42",
      "comm_timeout" : 120,
      "enable_nat64" : true,
      "white_list" : [ {
        "long_eui" : "c30e2c0af7a32e94",
        "pskd" : "Y85AFS9UP2CNW6UH4HAJ0WJ7DS3"
      }, {
        "long_eui" : "c139fc00afd7ee63",
        "pskd" : "WUHPYHEW4MWB2JEJK8XE"
      }, {
        "long_eui" : "c64e34305950d7c0",
        "pskd" : "9L8TUP"
      } ],
      "default_user_profile_id" : 1
    }
  }, {
    "id" : 2,
    "create_time" : "2024-04-03T19:55:22.000+0000",
    "update_time" : "2024-04-03T19:55:22.000+0000",
    "name" : "iot-profile-2",
    "app_id" : "THREAD_GATEWAY",
    "thread_gateway" : {
      "short_pan_id" : "dc63",
      "ext_pan_id" : "beb08788519dfa2c",
      "master_key" : "2c5b3a223dbb2271899a4ffd2d1ea6d9",
      "network_name" : "thread-network-2",
      "channel" : 15,
      "comm_credentials" : "5a081cb040cb886a8e603ca7e0b7",
      "comm_timeout" : 120,
      "enable_nat64" : true,
      "white_list" : [ {
        "long_eui" : "3996b42e65bc1134",
        "pskd" : "R7W6SCVD2XP7SPG8KH"
      }, {
        "long_eui" : "30613395f2401d2d",
        "pskd" : "PDWUSTGHK3"
      }, {
        "long_eui" : "f3189e61d3b6a8b2",
        "pskd" : "9U6GX1K188E"
      } ],
      "default_user_profile_id" : 1
    }
  } ]
}

cURL Request

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

Create IoT Profile Configuration

POST /iot-profiles

Request Fields

Path Type Description

name

String

The iot profile name.

app_id

String

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

thread_gateway

Object

When app_id = THREAD_GATEWAY provides definition of thread gateway.

thread_gateway.short_pan_id

String

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

thread_gateway.ext_pan_id

String

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

thread_gateway.master_key

String

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

thread_gateway.network_name

String

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

thread_gateway.channel

Number

802.15.4 channel number, 11-26

thread_gateway.comm_credentials

String

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

thread_gateway.comm_timeout

Number

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

thread_gateway.enable_nat64

Boolean

Enable NAT64 functions including the translator and the prefix publishing.

thread_gateway.white_list

Array

The table of approved Thread end-devices.

thread_gateway.white_list[].long_eui

String

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

thread_gateway.white_list[].pskd

String

thread_gateway.default_user_profile_id

Number

The default user-profile ID.

HTTP Request

POST /iot-profiles HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyMiwiZXhwIjoxNzEyNzc4OTIyfQ.txcbPw5NR3qusFkyWtlasQ91DkW6xlBfRIlBsb7AwBg
Content-Length: 678
Content-Type: application/json

{
  "name" : "test-iot-profile-1",
  "app_id" : "THREAD_GATEWAY",
  "thread_gateway" : {
    "short_pan_id" : "a6f3",
    "ext_pan_id" : "71e51d2521235d1c",
    "master_key" : "fc9886423633b03033209441762ef822",
    "network_name" : "thread-network-1",
    "channel" : 15,
    "comm_credentials" : "e887390cfc62",
    "comm_timeout" : 120,
    "enable_nat64" : true,
    "white_list" : [ {
      "long_eui" : "b0b7a2089787eac3",
      "pskd" : "D465SD3MR"
    }, {
      "long_eui" : "4eeeb4b509660924",
      "pskd" : "690R07PJL4XJG"
    }, {
      "long_eui" : "241f9a0597bd1a5c",
      "pskd" : "FTPD480EARLBRMCBNL03A5LL819JP"
    } ],
    "default_user_profile_id" : 1
  }
}

Response Fields

Path Type Description

id

Number

The iot profile ID.

name

String

The iot profile name.

create_time

String

The create time of the iot profile.

update_time

String

The update time of the iot profile.

app_id

String

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

thread_gateway

Object

When app_id = THREAD_GATEWAY provides definition of thread gateway.

thread_gateway.short_pan_id

String

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

thread_gateway.ext_pan_id

String

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

thread_gateway.master_key

String

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

thread_gateway.network_name

String

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

thread_gateway.channel

Number

802.15.4 channel number, 11-26

thread_gateway.comm_credentials

String

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

thread_gateway.comm_timeout

Number

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

thread_gateway.enable_nat64

Boolean

Enable NAT64 functions including the translator and the prefix publishing.

thread_gateway.white_list

Array

The table of approved Thread end-devices.

thread_gateway.white_list[].long_eui

String

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

thread_gateway.white_list[].pskd

String

thread_gateway.default_user_profile_id

Number

The default user-profile ID.

HTTP Response

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

{
  "id" : 1,
  "create_time" : "2024-04-03T19:55:22.000+0000",
  "update_time" : "2024-04-03T19:55:22.000+0000",
  "name" : "iot-profile-1",
  "app_id" : "THREAD_GATEWAY",
  "thread_gateway" : {
    "short_pan_id" : "cdca",
    "ext_pan_id" : "0a4262494be200fa",
    "master_key" : "72d27b163428d7a1c1aa074a32602a89",
    "network_name" : "thread-network-1",
    "channel" : 15,
    "comm_credentials" : "b363699e1408098a0e9d6eac3fa4e7a9",
    "comm_timeout" : 120,
    "enable_nat64" : true,
    "white_list" : [ {
      "long_eui" : "ed80676e9673dc64",
      "pskd" : "JF6NUP8P790GG7W27F2NB66"
    }, {
      "long_eui" : "bcbebb569aac3634",
      "pskd" : "392U2NS9F2PM3NF5JK2BACM15LTFCD"
    }, {
      "long_eui" : "1a5b1d28e9aa20fe",
      "pskd" : "C42EGWF9ER9WRWEE8AYVN9PLS4NDYG"
    } ],
    "default_user_profile_id" : 1
  }
}

cURL Request

$ curl 'https://api.extremecloudiq.com/iot-profiles' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyMiwiZXhwIjoxNzEyNzc4OTIyfQ.txcbPw5NR3qusFkyWtlasQ91DkW6xlBfRIlBsb7AwBg' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "test-iot-profile-1",
  "app_id" : "THREAD_GATEWAY",
  "thread_gateway" : {
    "short_pan_id" : "a6f3",
    "ext_pan_id" : "71e51d2521235d1c",
    "master_key" : "fc9886423633b03033209441762ef822",
    "network_name" : "thread-network-1",
    "channel" : 15,
    "comm_credentials" : "e887390cfc62",
    "comm_timeout" : 120,
    "enable_nat64" : true,
    "white_list" : [ {
      "long_eui" : "b0b7a2089787eac3",
      "pskd" : "D465SD3MR"
    }, {
      "long_eui" : "4eeeb4b509660924",
      "pskd" : "690R07PJL4XJG"
    }, {
      "long_eui" : "241f9a0597bd1a5c",
      "pskd" : "FTPD480EARLBRMCBNL03A5LL819JP"
    } ],
    "default_user_profile_id" : 1
  }
}'

Get IoT Profile by ID

GET /iot-profiles/{id}

Path Parameters

Table 117. /iot-profiles/{id}
Parameter	Description
`id`	The iot profile ID.

HTTP Request

GET /iot-profiles/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyMiwiZXhwIjoxNzEyNzc4OTIyfQ.txcbPw5NR3qusFkyWtlasQ91DkW6xlBfRIlBsb7AwBg
Content-Type: application/json

Response Fields

Path Type Description

id

Number

The iot profile ID.

name

String

The iot profile name.

create_time

String

The create time of the iot profile.

update_time

String

The update time of the iot profile.

app_id

String

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

thread_gateway

Object

When app_id = THREAD_GATEWAY provides definition of thread gateway.

thread_gateway.short_pan_id

String

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

thread_gateway.ext_pan_id

String

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

thread_gateway.master_key

String

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

thread_gateway.network_name

String

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

thread_gateway.channel

Number

802.15.4 channel number, 11-26

thread_gateway.comm_credentials

String

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

thread_gateway.comm_timeout

Number

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

thread_gateway.enable_nat64

Boolean

Enable NAT64 functions including the translator and the prefix publishing.

thread_gateway.white_list

Array

The table of approved Thread end-devices.

thread_gateway.white_list[].long_eui

String

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

thread_gateway.white_list[].pskd

String

thread_gateway.default_user_profile_id

Number

The default user-profile ID.

HTTP Response

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

{
  "id" : 1,
  "create_time" : "2024-04-03T19:55:22.000+0000",
  "update_time" : "2024-04-03T19:55:22.000+0000",
  "name" : "iot-profile-1",
  "app_id" : "THREAD_GATEWAY",
  "thread_gateway" : {
    "short_pan_id" : "43f6",
    "ext_pan_id" : "53b806da07bd2453",
    "master_key" : "0bc71e93562065de192229b77b4d1cba",
    "network_name" : "thread-network-1",
    "channel" : 15,
    "comm_credentials" : "05b5a2a0204c8f8a9db652",
    "comm_timeout" : 120,
    "enable_nat64" : true,
    "white_list" : [ {
      "long_eui" : "c61462abb4755042",
      "pskd" : "U1LM7RN8"
    }, {
      "long_eui" : "cdebf94f5f543b4c",
      "pskd" : "KJXPDY6REARYUPNHULSD4P2"
    }, {
      "long_eui" : "bebb8ca24e0d3551",
      "pskd" : "KBVL34V69MRR124NEN"
    } ],
    "default_user_profile_id" : 1
  }
}

cURL Request

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

Update IoT Profile Configuration

PUT /iot-profiles/{id}

Path Parameters

Table 118. /iot-profiles/{id}
Parameter	Description
`id`	The iot profile ID.

Request Fields

Path Type Description

name

String

The iot profile name.

app_id

String

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

thread_gateway

Object

When app_id = THREAD_GATEWAY provides definition of thread gateway.

thread_gateway.short_pan_id

String

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

thread_gateway.ext_pan_id

String

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

thread_gateway.master_key

String

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

thread_gateway.network_name

String

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

thread_gateway.channel

Number

802.15.4 channel number, 11-26

thread_gateway.comm_credentials

String

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

thread_gateway.comm_timeout

Number

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

thread_gateway.enable_nat64

Boolean

Enable NAT64 functions including the translator and the prefix publishing.

thread_gateway.white_list

Array

The table of approved Thread end-devices.

thread_gateway.white_list[].long_eui

String

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

thread_gateway.white_list[].pskd

String

thread_gateway.default_user_profile_id

Number

The default user-profile ID.

HTTP Request

PUT /iot-profiles/438086664193 HTTP/1.1
Content-Length: 680
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyMiwiZXhwIjoxNzEyNzc4OTIyfQ.txcbPw5NR3qusFkyWtlasQ91DkW6xlBfRIlBsb7AwBg
Content-Type: application/json

{
  "name" : "test-iot-profile-1",
  "app_id" : "THREAD_GATEWAY",
  "thread_gateway" : {
    "short_pan_id" : "3ede",
    "ext_pan_id" : "aa9fabd0d2ce76b8",
    "master_key" : "857437f2970c0687f6c2dfabc15600f4",
    "network_name" : "thread-network-1",
    "channel" : 15,
    "comm_credentials" : "abd812a22026f2a37039cd3c",
    "comm_timeout" : 120,
    "enable_nat64" : true,
    "white_list" : [ {
      "long_eui" : "a995157df01150bc",
      "pskd" : "D46B94XU72P9MNWLS7"
    }, {
      "long_eui" : "4f80d2d7de65b997",
      "pskd" : "5E69E0G3GLYNX6W"
    }, {
      "long_eui" : "2eb4375e88e4f7cd",
      "pskd" : "C9A6AX3Y"
    } ],
    "default_user_profile_id" : 1
  }
}

Response Fields

Path Type Description

id

Number

The iot profile ID.

name

String

The iot profile name.

create_time

String

The create time of the iot profile.

update_time

String

The update time of the iot profile.

app_id

String

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

thread_gateway

Object

When app_id = THREAD_GATEWAY provides definition of thread gateway.

thread_gateway.short_pan_id

String

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

thread_gateway.ext_pan_id

String

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

thread_gateway.master_key

String

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

thread_gateway.network_name

String

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

thread_gateway.channel

Number

802.15.4 channel number, 11-26

thread_gateway.comm_credentials

String

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

thread_gateway.comm_timeout

Number

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

thread_gateway.enable_nat64

Boolean

Enable NAT64 functions including the translator and the prefix publishing.

thread_gateway.white_list

Array

The table of approved Thread end-devices.

thread_gateway.white_list[].long_eui

String

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

thread_gateway.white_list[].pskd

String

thread_gateway.default_user_profile_id

Number

The default user-profile ID.

HTTP Response

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

{
  "id" : 1,
  "create_time" : "2024-04-03T19:55:22.000+0000",
  "update_time" : "2024-04-03T19:55:22.000+0000",
  "name" : "iot-profile-1",
  "app_id" : "THREAD_GATEWAY",
  "thread_gateway" : {
    "short_pan_id" : "60c9",
    "ext_pan_id" : "1c0fd1088c30a018",
    "master_key" : "6d6af56945cd5bcf7f3c9351a843899e",
    "network_name" : "thread-network-1",
    "channel" : 15,
    "comm_credentials" : "ae40236241f",
    "comm_timeout" : 120,
    "enable_nat64" : true,
    "white_list" : [ {
      "long_eui" : "2fbe88ff8afd712f",
      "pskd" : "6SGYKC3MS6TPA6SPDCBHY5MUL410"
    }, {
      "long_eui" : "a5c0b027c2229a10",
      "pskd" : "B0NX2ND529MMK9"
    }, {
      "long_eui" : "64767f1dafdea369",
      "pskd" : "SF9JNN2608CAAJ8CB"
    } ],
    "default_user_profile_id" : 1
  }
}

cURL Request

$ curl 'https://api.extremecloudiq.com/iot-profiles/438086664193' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyMiwiZXhwIjoxNzEyNzc4OTIyfQ.txcbPw5NR3qusFkyWtlasQ91DkW6xlBfRIlBsb7AwBg' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "test-iot-profile-1",
  "app_id" : "THREAD_GATEWAY",
  "thread_gateway" : {
    "short_pan_id" : "3ede",
    "ext_pan_id" : "aa9fabd0d2ce76b8",
    "master_key" : "857437f2970c0687f6c2dfabc15600f4",
    "network_name" : "thread-network-1",
    "channel" : 15,
    "comm_credentials" : "abd812a22026f2a37039cd3c",
    "comm_timeout" : 120,
    "enable_nat64" : true,
    "white_list" : [ {
      "long_eui" : "a995157df01150bc",
      "pskd" : "D46B94XU72P9MNWLS7"
    }, {
      "long_eui" : "4f80d2d7de65b997",
      "pskd" : "5E69E0G3GLYNX6W"
    }, {
      "long_eui" : "2eb4375e88e4f7cd",
      "pskd" : "C9A6AX3Y"
    } ],
    "default_user_profile_id" : 1
  }
}'

Delete IoT Profile Configuration

DELETE /iot-profiles/{id}

Path Parameters

Table 119. /iot-profiles/{id}
Parameter	Description
`id`	The iot profile ID.

HTTP Request

DELETE /iot-profiles/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyMiwiZXhwIjoxNzEyNzc4OTIyfQ.txcbPw5NR3qusFkyWtlasQ91DkW6xlBfRIlBsb7AwBg
Content-Type: application/json

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
RateLimit-Remaining: 7443
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/iot-profiles/438086664193' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyMiwiZXhwIjoxNzEyNzc4OTIyfQ.txcbPw5NR3qusFkyWtlasQ91DkW6xlBfRIlBsb7AwBg' \
    -H 'Content-Type: application/json'

Configuration - Authentication

List Active Directory server

GET /ad-servers

Request Parameters

Parameter Description

page

Page number

limit

Page size

HTTP Request

GET /ad-servers HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNywiZXhwIjoxNzEyNzc4OTI3fQ.1ru2kSXseyxpWNEvOZngpAFGqi6HMnPa7HBwjiS4cH8
Host: api.extremecloudiq.com
Content-Type: application/json

Response Fields

Path Type Description

page

Number

The current page number

count

Number

The element count of the current page

total_pages

Number

The total page number based on request page size

total_count

Number

The total element count

data[].id

Number

The active directory server ID

data[].create_time

String

The create time

data[].update_time

String

The last update time

data[].org_id

Number

The organization identifier, valid when enabling HIQ feature

data[].name

String

The active directory server name

data[].description

String

The description of active directory server

data[].base_dn

String

The base DN of active directory server

data[].enable_tls

Boolean

Flag to enable TLS

data[].bind_dn

String

The bind DN for active directory server

data[].bind_dn_password

String

The bind DN password for active directory server

data[].domain

String

The domain of active directory server

data[].computer_ou

String

The computer OU for active directory server

data[].domain_admin

String

The domain admin of active directory server

data[].domain_admin_password

String

The domain admin password of active directory server

data[].enable_save_domain_admin_credentials

Boolean

Flag to enable save domain admin credentials

data[].short_domain

String

The short domain of active directory server

data[].realm

String

The realm for active directory server

data[].base_dn_fetch_mode

String

The base DN fetch mode for active directory server

data[].connection_setup_device_id

Number

The connection setup device ID for active directory server

data[].l3_address_profile_id

Number

The associate L3 address profile ID

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Content-Length: 2171
RateLimit-Remaining: 7400
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

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 1,
  "total_count" : 3,
  "data" : [ {
    "id" : 1,
    "create_time" : "2024-04-03T19:55:27.000+0000",
    "update_time" : "2024-04-03T19:55:27.000+0000",
    "org_id" : 0,
    "name" : "test-ad-server-1",
    "description" : "test ad server 1",
    "base_dn" : "dc=TestLAB,dc=COM",
    "enable_tls" : false,
    "bind_dn" : "administrator",
    "bind_dn_password" : "***",
    "domain" : "testlab.com",
    "computer_ou" : "",
    "domain_admin" : "administrator",
    "domain_admin_password" : "***",
    "enable_save_domain_admin_credentials" : true,
    "short_domain" : "testlab.com",
    "realm" : "testlab.com",
    "base_dn_fetch_mode" : "AUTO",
    "connection_setup_device_id" : 1,
    "l3_address_profile_id" : 1
  }, {
    "id" : 2,
    "create_time" : "2024-04-03T19:55:27.000+0000",
    "update_time" : "2024-04-03T19:55:27.000+0000",
    "org_id" : 0,
    "name" : "test-ad-server-1",
    "description" : "test ad server 2",
    "base_dn" : "dc=TestLAB,dc=COM",
    "enable_tls" : false,
    "bind_dn" : "administrator",
    "bind_dn_password" : "***",
    "domain" : "testlab.com",
    "computer_ou" : "",
    "domain_admin" : "administrator",
    "domain_admin_password" : "***",
    "enable_save_domain_admin_credentials" : true,
    "short_domain" : "testlab.com",
    "realm" : "testlab.com",
    "base_dn_fetch_mode" : "AUTO",
    "connection_setup_device_id" : 1,
    "l3_address_profile_id" : 1
  }, {
    "id" : 3,
    "create_time" : "2024-04-03T19:55:27.000+0000",
    "update_time" : "2024-04-03T19:55:27.000+0000",
    "org_id" : 0,
    "name" : "test-ad-server-1",
    "description" : "test ad server 3",
    "base_dn" : "dc=TestLAB,dc=COM",
    "enable_tls" : false,
    "bind_dn" : "administrator",
    "bind_dn_password" : "***",
    "domain" : "testlab.com",
    "computer_ou" : "",
    "domain_admin" : "administrator",
    "domain_admin_password" : "***",
    "enable_save_domain_admin_credentials" : true,
    "short_domain" : "testlab.com",
    "realm" : "testlab.com",
    "base_dn_fetch_mode" : "AUTO",
    "connection_setup_device_id" : 1,
    "l3_address_profile_id" : 1
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/ad-servers' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNywiZXhwIjoxNzEyNzc4OTI3fQ.1ru2kSXseyxpWNEvOZngpAFGqi6HMnPa7HBwjiS4cH8' \
    -H 'Content-Type: application/json'

List captive web portals

GET /cwps

Request Parameters

Parameter Description

page

Page number

limit

Page size

HTTP Request

GET /cwps?page=1&limit=10 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNSwiZXhwIjoxNzEyNzc4OTI1fQ.eU5MJBEF1MpHvs0P5s0dRBd9fAP3KR6HgKhx35JLG-U
Content-Type: application/json

Response Fields

Path Type Description

page

Number

The current page number

count

Number

The element count of the current page

total_pages

Number

The total page number based on request page size

total_count

Number

The total element count

data[].id

Number

The Captive Web Portals ID

data[].create_time

String

The create time

data[].update_time

String

The last update time

data[].org_id

Number

The organization identifier, valid when enabling HIQ feature

data[].name

String

The Captive Web Portals name

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: 427
X-Content-Type-Options: nosniff
RateLimit-Remaining: 7424
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 1,
  "total_count" : 2,
  "data" : [ {
    "id" : 1,
    "create_time" : "2024-04-03T19:55:25.000+0000",
    "update_time" : "2024-04-03T19:55:25.000+0000",
    "org_id" : 0,
    "name" : "test-cwp-1"
  }, {
    "id" : 2,
    "create_time" : "2024-04-03T19:55:25.000+0000",
    "update_time" : "2024-04-03T19:55:25.000+0000",
    "org_id" : 0,
    "name" : "test-cwp-2"
  } ]
}

cURL Request

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

List LDAP servers

GET /ldap-servers

Request Parameters

Parameter Description

page

Page number

limit

Page size

HTTP Request

GET /ldap-servers?page=1&limit=10 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNSwiZXhwIjoxNzEyNzc4OTI1fQ.eU5MJBEF1MpHvs0P5s0dRBd9fAP3KR6HgKhx35JLG-U
Content-Type: application/json

Response Fields

Path Type Description

page

Number

The current page number

count

Number

The element count of the current page

total_pages

Number

The total page number based on request page size

total_count

Number

The total element count

data[].id

Number

The LDAP server ID

data[].create_time

String

The create time

data[].update_time

String

The last update time

data[].name

String

The LDAP server name

data[].description

String

The description of LDAP server

data[].enable_tls

Boolean

Flag to enable TLS for LDAP server

data[].bind_dn

String

The bind DN of LDAP server

data[].bind_dn_password

String

The bind DN password of LDAP server

data[].base_dn

String

The Radius user base DN

data[].protocol_type

String

The protocol type of LDAP server

data[].l3_address_profile_id

Number

The associate L3 address profile ID

data[].enable_strip_realm_name

Boolean

Flag to enable strip realm name

data[].destination_port

Number

The destination port of LDAP server

data[].verification_mode

String

The verification mode of LDAP server

data[].client_key_password

String

The client key password

data[].ca_certificate_id

Number

The CA certificate ID

data[].client_certificate_id

Number

The client certificate ID

data[].client_key_id

Number

The client key ID

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
RateLimit-Remaining: 7422
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: 2080

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 1,
  "total_count" : 3,
  "data" : [ {
    "id" : 438086664193,
    "create_time" : "2024-04-03T19:55:25.000+0000",
    "update_time" : "2024-04-03T19:55:25.000+0000",
    "name" : "test-ldap-1",
    "description" : "test-ldap-desc-1",
    "enable_tls" : false,
    "bind_dn" : "test.extreme.com",
    "bind_dn_password" : "***",
    "base_dn" : "extreme.com",
    "l3_address_profile_id" : 438086664292,
    "protocol_type" : "LDAPS",
    "enable_strip_realm_name" : false,
    "destination_port" : 1000,
    "verification_mode" : "DEMAND",
    "ca_certificate_id" : 438086664212,
    "client_certificate_id" : 438086664222,
    "client_key_id" : 438086664232,
    "client_key_password" : "***"
  }, {
    "id" : 438086664194,
    "create_time" : "2024-04-03T19:55:25.000+0000",
    "update_time" : "2024-04-03T19:55:25.000+0000",
    "name" : "test-ldap-2",
    "description" : "test-ldap-desc-2",
    "enable_tls" : true,
    "bind_dn" : "test.extreme.com",
    "bind_dn_password" : "***",
    "base_dn" : "extreme.com",
    "l3_address_profile_id" : 438086664292,
    "protocol_type" : "LDAPS",
    "enable_strip_realm_name" : false,
    "destination_port" : 1000,
    "verification_mode" : "DEMAND",
    "ca_certificate_id" : 438086664212,
    "client_certificate_id" : 438086664222,
    "client_key_id" : 438086664232,
    "client_key_password" : "***"
  }, {
    "id" : 438086664195,
    "create_time" : "2024-04-03T19:55:25.000+0000",
    "update_time" : "2024-04-03T19:55:25.000+0000",
    "name" : "test-ldap-3",
    "description" : "test-ldap-desc-3",
    "enable_tls" : false,
    "bind_dn" : "test.extreme.com",
    "bind_dn_password" : "***",
    "base_dn" : "extreme.com",
    "l3_address_profile_id" : 438086664292,
    "protocol_type" : "LDAPS",
    "enable_strip_realm_name" : false,
    "destination_port" : 1000,
    "verification_mode" : "DEMAND",
    "ca_certificate_id" : 438086664212,
    "client_certificate_id" : 438086664222,
    "client_key_id" : 438086664232,
    "client_key_password" : "***"
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/ldap-servers?page=1&limit=10' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNSwiZXhwIjoxNzEyNzc4OTI1fQ.eU5MJBEF1MpHvs0P5s0dRBd9fAP3KR6HgKhx35JLG-U' \
    -H 'Content-Type: application/json'

Create LDAP server

POST /ldap-servers

Request Fields

Path Type Description

name

String

The LDAP server name

description

String

The description of LDAP server

enable_tls

Boolean

Flag to enable TLS for LDAP server

bind_dn

String

The bind DN of LDAP server

bind_dn_password

String

The bind DN password of LDAP server

base_dn

String

The Radius user base DN

l3_address_profile_id

Number

The associate L3 address profile ID

protocol_type

String

The protocol type of LDAP server

enable_strip_realm_name

Boolean

Flag to enable strip realm name

destination_port

Number

The destination port of LDAP server

verification_mode

String

The verification mode of LDAP server

client_key_password

String

The client key password

ca_certificate_id

Number

The certificate ID of CA

client_certificate_id

Number

The client certificate ID

client_key_id

Number

The client key ID

HTTP Request

POST /ldap-servers HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNSwiZXhwIjoxNzEyNzc4OTI1fQ.eU5MJBEF1MpHvs0P5s0dRBd9fAP3KR6HgKhx35JLG-U
Content-Length: 501
Content-Type: application/json

{
  "name" : "test-ldap-1",
  "description" : "test-ldap-desc-1",
  "enable_tls" : false,
  "bind_dn" : "test.extreme.com",
  "bind_dn_password" : "***",
  "base_dn" : "extreme.com",
  "l3_address_profile_id" : 438086664292,
  "protocol_type" : "LDAPS",
  "enable_strip_realm_name" : false,
  "destination_port" : 1000,
  "verification_mode" : "DEMAND",
  "ca_certificate_id" : 438086664212,
  "client_certificate_id" : 438086664222,
  "client_key_id" : 438086664232,
  "client_key_password" : "***"
}

Response Fields

Path Type Description

id

Number

The LDAP server ID

create_time

String

The create time

update_time

String

The last update time

name

String

The LDAP server name

description

String

The description of LDAP server

enable_tls

Boolean

Flag to enable TLS for LDAP server

bind_dn

String

The bind DN of LDAP server

bind_dn_password

String

The bind DN password of LDAP server

base_dn

String

The Radius user base DN

l3_address_profile_id

Number

The associate L3 address profile ID

protocol_type

String

The protocol type of LDAP server

enable_strip_realm_name

Boolean

Flag to enable strip realm name

destination_port

Number

The destination port of LDAP server

verification_mode

String

The verification mode of LDAP server

client_key_password

String

The client key password

ca_certificate_id

Number

The CA certificate ID

client_certificate_id

Number

The client certificate ID

client_key_id

Number

The client key ID

HTTP Response

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

{
  "id" : 438086664193,
  "create_time" : "2024-04-03T19:55:25.000+0000",
  "update_time" : "2024-04-03T19:55:25.000+0000",
  "name" : "test-ldap-1",
  "description" : "test-ldap-desc-1",
  "enable_tls" : false,
  "bind_dn" : "test.extreme.com",
  "bind_dn_password" : "***",
  "base_dn" : "extreme.com",
  "l3_address_profile_id" : 438086664292,
  "protocol_type" : "LDAPS",
  "enable_strip_realm_name" : false,
  "destination_port" : 1000,
  "verification_mode" : "DEMAND",
  "ca_certificate_id" : 438086664212,
  "client_certificate_id" : 438086664222,
  "client_key_id" : 438086664232,
  "client_key_password" : "***"
}

cURL Request

$ curl 'https://api.extremecloudiq.com/ldap-servers' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNSwiZXhwIjoxNzEyNzc4OTI1fQ.eU5MJBEF1MpHvs0P5s0dRBd9fAP3KR6HgKhx35JLG-U' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "test-ldap-1",
  "description" : "test-ldap-desc-1",
  "enable_tls" : false,
  "bind_dn" : "test.extreme.com",
  "bind_dn_password" : "***",
  "base_dn" : "extreme.com",
  "l3_address_profile_id" : 438086664292,
  "protocol_type" : "LDAPS",
  "enable_strip_realm_name" : false,
  "destination_port" : 1000,
  "verification_mode" : "DEMAND",
  "ca_certificate_id" : 438086664212,
  "client_certificate_id" : 438086664222,
  "client_key_id" : 438086664232,
  "client_key_password" : "***"
}'

Get LDAP server

GET /ldap-servers/{id}

Path parameters

Table 120. /ldap-servers/{id}
Parameter	Description
`id`	The LDAP server ID

HTTP Request

GET /ldap-servers/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNSwiZXhwIjoxNzEyNzc4OTI1fQ.eU5MJBEF1MpHvs0P5s0dRBd9fAP3KR6HgKhx35JLG-U
Content-Type: application/json

Response Fields

Path Type Description

id

Number

The LDAP server ID

create_time

String

The create time

update_time

String

The last update time

name

String

The LDAP server name

description

String

The description of LDAP server

enable_tls

Boolean

Flag to enable TLS for LDAP server

bind_dn

String

The bind DN of LDAP server

bind_dn_password

String

The bind DN password of LDAP server

base_dn

String

The Radius user base DN

l3_address_profile_id

Number

The associate L3 address profile ID

protocol_type

String

The protocol type of LDAP server

enable_strip_realm_name

Boolean

Flag to enable strip realm name

destination_port

Number

The destination port of LDAP server

verification_mode

String

The verification mode of LDAP server

client_key_password

String

The client key password

ca_certificate_id

Number

The CA certificate ID

client_certificate_id

Number

The client certificate ID

client_key_id

Number

The client key ID

HTTP Response

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

{
  "id" : 438086664193,
  "create_time" : "2024-04-03T19:55:25.000+0000",
  "update_time" : "2024-04-03T19:55:25.000+0000",
  "name" : "test-ldap-1",
  "description" : "test-ldap-desc-1",
  "enable_tls" : false,
  "bind_dn" : "test.extreme.com",
  "bind_dn_password" : "***",
  "base_dn" : "extreme.com",
  "l3_address_profile_id" : 438086664292,
  "protocol_type" : "LDAPS",
  "enable_strip_realm_name" : false,
  "destination_port" : 1000,
  "verification_mode" : "DEMAND",
  "ca_certificate_id" : 438086664212,
  "client_certificate_id" : 438086664222,
  "client_key_id" : 438086664232,
  "client_key_password" : "***"
}

cURL Request

$ curl 'https://api.extremecloudiq.com/ldap-servers/438086664193' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNSwiZXhwIjoxNzEyNzc4OTI1fQ.eU5MJBEF1MpHvs0P5s0dRBd9fAP3KR6HgKhx35JLG-U' \
    -H 'Content-Type: application/json'

Update LDAP server

PUT /ldap-servers/{id}

Path Parameters

Table 121. /ldap-servers/{id}
Parameter	Description
`id`	The LDAP server ID

Request Fields

Path Type Description

name

String

The LDAP server name

description

String

The LDAP server description

enable_tls

Boolean

Flag to enable TLS for LDAP server

bind_dn

String

The bind DN of LDAP server

bind_dn_password

String

The bind DN password of LDAP server

base_dn

String

The Radius user base DN

l3_address_profile_id

Number

The associate L3 address profile ID

protocol_type

String

The protocol type of LDAP server

enable_strip_realm_name

Boolean

Flag to enable strip realm name

destination_port

Number

The destination port of LDAP server

verification_mode

String

The verification mode of LDAP server

ca_certificate_id

Number

The certificate ID of CA

client_certificate_id

Number

The client certificate ID

client_key_id

Number

The client key ID

HTTP Request

PUT /ldap-servers/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNSwiZXhwIjoxNzEyNzc4OTI1fQ.eU5MJBEF1MpHvs0P5s0dRBd9fAP3KR6HgKhx35JLG-U
Content-Length: 468
Content-Type: application/json

{
  "name" : "test-ldap-1",
  "description" : "test-description",
  "enable_tls" : false,
  "bind_dn" : "test.extreme.com",
  "bind_dn_password" : "***",
  "base_dn" : "extreme.com",
  "l3_address_profile_id" : 438086664292,
  "protocol_type" : "LDAPS",
  "enable_strip_realm_name" : false,
  "destination_port" : 1000,
  "verification_mode" : "DEMAND",
  "ca_certificate_id" : 438086664212,
  "client_certificate_id" : 438086664222,
  "client_key_id" : 438086664232
}

Response Fields

Path Type Description

id

Number

The LDAP server ID

create_time

String

The create time

update_time

String

The last update time

name

String

The LDAP server name

description

String

The description of LDAP server

enable_tls

Boolean

Flag to enable TLS for LDAP server

bind_dn

String

The bind DN of LDAP server

bind_dn_password

String

The bind DN password of LDAP server

base_dn

String

The Radius user base DN

l3_address_profile_id

Number

The associate L3 address profile ID

protocol_type

String

The protocol type of LDAP server

enable_strip_realm_name

Boolean

Flag to enable strip realm name

destination_port

Number

The destination port of LDAP server

verification_mode

String

The verification mode of LDAP server

client_key_password

String

The client key password

ca_certificate_id

Number

The CA certificate ID

client_certificate_id

Number

The client certificate ID

client_key_id

Number

The client key ID

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

{
  "id" : 438086664193,
  "create_time" : "2024-04-03T19:55:25.000+0000",
  "update_time" : "2024-04-03T19:55:25.000+0000",
  "name" : "test-ldap-1",
  "description" : "test-ldap-desc-1",
  "enable_tls" : false,
  "bind_dn" : "test.extreme.com",
  "bind_dn_password" : "***",
  "base_dn" : "extreme.com",
  "l3_address_profile_id" : 438086664292,
  "protocol_type" : "LDAPS",
  "enable_strip_realm_name" : false,
  "destination_port" : 1000,
  "verification_mode" : "DEMAND",
  "ca_certificate_id" : 438086664212,
  "client_certificate_id" : 438086664222,
  "client_key_id" : 438086664232,
  "client_key_password" : "***"
}

cURL Request

$ curl 'https://api.extremecloudiq.com/ldap-servers/438086664193' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNSwiZXhwIjoxNzEyNzc4OTI1fQ.eU5MJBEF1MpHvs0P5s0dRBd9fAP3KR6HgKhx35JLG-U' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "test-ldap-1",
  "description" : "test-description",
  "enable_tls" : false,
  "bind_dn" : "test.extreme.com",
  "bind_dn_password" : "***",
  "base_dn" : "extreme.com",
  "l3_address_profile_id" : 438086664292,
  "protocol_type" : "LDAPS",
  "enable_strip_realm_name" : false,
  "destination_port" : 1000,
  "verification_mode" : "DEMAND",
  "ca_certificate_id" : 438086664212,
  "client_certificate_id" : 438086664222,
  "client_key_id" : 438086664232
}'

Delete LDAP server

DELETE /ldap-servers/{id}

Path Parameters

Table 122. /ldap-servers/{id}
Parameter	Description
`id`	The LDAP server ID

HTTP Request

DELETE /ldap-servers/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNSwiZXhwIjoxNzEyNzc4OTI1fQ.eU5MJBEF1MpHvs0P5s0dRBd9fAP3KR6HgKhx35JLG-U
Content-Type: application/json

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Remaining: 7420
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/ldap-servers/438086664193' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNSwiZXhwIjoxNzEyNzc4OTI1fQ.eU5MJBEF1MpHvs0P5s0dRBd9fAP3KR6HgKhx35JLG-U' \
    -H 'Content-Type: application/json'

List RADIUS client objects

GET /radius-client-objects

Request Parameters

Parameter Description

page

Page number

limit

Page size

HTTP Request

GET /radius-client-objects?page=1&limit=10 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNiwiZXhwIjoxNzEyNzc4OTI2fQ.XlCubs47IZDajOrRrv0U0cEw4Qwxm93r_FYT1R99qqY
Content-Type: application/json

Response Fields

Path Type Description

page

Number

The current page number.

count

Number

The element count of the current page.

total_pages

Number

The total page number based on request page size.

total_count

Number

The total element count.

data[].id

Number

The RADIUS client object ID.

data[].create_time

String

The create time.

data[].update_time

String

The last update time.

data[].name

String

The RADIUS client object configuration name

data[].description

String

The RADIUS client object description.

data[].enable_inject_operator_name_attribute

Boolean

The flag for enable inject operator name attribute.

data[].enable_message_authenticator_attribute

Boolean

The flag for enable message authenticator attribute

data[].enable_permit_dynamic_authorization_message_change

Boolean

The flag for enable permit dynamic authorization message change

data[].retry_interval

Number

The retry interval, 60 - 100000000 seconds

data[].accounting_interim_update_interval

Number

The accounting interim update interval, 60 - 100000000 seconds

data[].entries[].server_role

String

The RADIUS client object entry role, Primary, Backup1, Backup2…

data[].entries[].server_type

String

The entry server type: INTERNAL_RADIUS_SERVER, EXTERNAL_RADIUS_SERVER, INTERNAL_RADIUS_PROXY

data[].entries[].radius_server_id

Number

The RADIUS client object entry RADIUS server 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
Content-Length: 5821
RateLimit-Remaining: 7416
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 2,
  "total_count" : 15,
  "data" : [ {
    "id" : 1,
    "create_time" : "2024-04-03T19:55:26.000+0000",
    "update_time" : "2024-04-03T19:55:26.000+0000",
    "name" : "RADIUS_CLIENT_OBJECT0",
    "description" : "test",
    "enable_inject_operator_name_attribute" : true,
    "enable_message_authenticator_attribute" : true,
    "enable_permit_dynamic_authorization_message_change" : true,
    "retry_interval" : 60,
    "accounting_interim_update_interval" : 60,
    "entries" : [ {
      "server_role" : "PRIMARY",
      "server_type" : "EXTERNAL_RADIUS_SERVER",
      "radius_server_id" : 3
    } ]
  }, {
    "id" : 2,
    "create_time" : "2024-04-03T19:55:26.000+0000",
    "update_time" : "2024-04-03T19:55:26.000+0000",
    "name" : "RADIUS_CLIENT_OBJECT1",
    "description" : "test",
    "enable_inject_operator_name_attribute" : true,
    "enable_message_authenticator_attribute" : true,
    "enable_permit_dynamic_authorization_message_change" : true,
    "retry_interval" : 60,
    "accounting_interim_update_interval" : 60,
    "entries" : [ {
      "server_role" : "PRIMARY",
      "server_type" : "EXTERNAL_RADIUS_SERVER",
      "radius_server_id" : 3
    } ]
  }, {
    "id" : 3,
    "create_time" : "2024-04-03T19:55:26.000+0000",
    "update_time" : "2024-04-03T19:55:26.000+0000",
    "name" : "RADIUS_CLIENT_OBJECT2",
    "description" : "test",
    "enable_inject_operator_name_attribute" : true,
    "enable_message_authenticator_attribute" : true,
    "enable_permit_dynamic_authorization_message_change" : true,
    "retry_interval" : 60,
    "accounting_interim_update_interval" : 60,
    "entries" : [ {
      "server_role" : "PRIMARY",
      "server_type" : "EXTERNAL_RADIUS_SERVER",
      "radius_server_id" : 3
    } ]
  }, {
    "id" : 4,
    "create_time" : "2024-04-03T19:55:26.000+0000",
    "update_time" : "2024-04-03T19:55:26.000+0000",
    "name" : "RADIUS_CLIENT_OBJECT3",
    "description" : "test",
    "enable_inject_operator_name_attribute" : true,
    "enable_message_authenticator_attribute" : true,
    "enable_permit_dynamic_authorization_message_change" : true,
    "retry_interval" : 60,
    "accounting_interim_update_interval" : 60,
    "entries" : [ {
      "server_role" : "PRIMARY",
      "server_type" : "EXTERNAL_RADIUS_SERVER",
      "radius_server_id" : 3
    } ]
  }, {
    "id" : 5,
    "create_time" : "2024-04-03T19:55:26.000+0000",
    "update_time" : "2024-04-03T19:55:26.000+0000",
    "name" : "RADIUS_CLIENT_OBJECT4",
    "description" : "test",
    "enable_inject_operator_name_attribute" : true,
    "enable_message_authenticator_attribute" : true,
    "enable_permit_dynamic_authorization_message_change" : true,
    "retry_interval" : 60,
    "accounting_interim_update_interval" : 60,
    "entries" : [ {
      "server_role" : "PRIMARY",
      "server_type" : "EXTERNAL_RADIUS_SERVER",
      "radius_server_id" : 3
    } ]
  }, {
    "id" : 6,
    "create_time" : "2024-04-03T19:55:26.000+0000",
    "update_time" : "2024-04-03T19:55:26.000+0000",
    "name" : "RADIUS_CLIENT_OBJECT5",
    "description" : "test",
    "enable_inject_operator_name_attribute" : true,
    "enable_message_authenticator_attribute" : true,
    "enable_permit_dynamic_authorization_message_change" : true,
    "retry_interval" : 60,
    "accounting_interim_update_interval" : 60,
    "entries" : [ {
      "server_role" : "PRIMARY",
      "server_type" : "EXTERNAL_RADIUS_SERVER",
      "radius_server_id" : 3
    } ]
  }, {
    "id" : 7,
    "create_time" : "2024-04-03T19:55:26.000+0000",
    "update_time" : "2024-04-03T19:55:26.000+0000",
    "name" : "RADIUS_CLIENT_OBJECT6",
    "description" : "test",
    "enable_inject_operator_name_attribute" : true,
    "enable_message_authenticator_attribute" : true,
    "enable_permit_dynamic_authorization_message_change" : true,
    "retry_interval" : 60,
    "accounting_interim_update_interval" : 60,
    "entries" : [ {
      "server_role" : "PRIMARY",
      "server_type" : "EXTERNAL_RADIUS_SERVER",
      "radius_server_id" : 3
    } ]
  }, {
    "id" : 8,
    "create_time" : "2024-04-03T19:55:26.000+0000",
    "update_time" : "2024-04-03T19:55:26.000+0000",
    "name" : "RADIUS_CLIENT_OBJECT7",
    "description" : "test",
    "enable_inject_operator_name_attribute" : true,
    "enable_message_authenticator_attribute" : true,
    "enable_permit_dynamic_authorization_message_change" : true,
    "retry_interval" : 60,
    "accounting_interim_update_interval" : 60,
    "entries" : [ {
      "server_role" : "PRIMARY",
      "server_type" : "EXTERNAL_RADIUS_SERVER",
      "radius_server_id" : 3
    } ]
  }, {
    "id" : 9,
    "create_time" : "2024-04-03T19:55:26.000+0000",
    "update_time" : "2024-04-03T19:55:26.000+0000",
    "name" : "RADIUS_CLIENT_OBJECT8",
    "description" : "test",
    "enable_inject_operator_name_attribute" : true,
    "enable_message_authenticator_attribute" : true,
    "enable_permit_dynamic_authorization_message_change" : true,
    "retry_interval" : 60,
    "accounting_interim_update_interval" : 60,
    "entries" : [ {
      "server_role" : "PRIMARY",
      "server_type" : "EXTERNAL_RADIUS_SERVER",
      "radius_server_id" : 3
    } ]
  }, {
    "id" : 10,
    "create_time" : "2024-04-03T19:55:26.000+0000",
    "update_time" : "2024-04-03T19:55:26.000+0000",
    "name" : "RADIUS_CLIENT_OBJECT9",
    "description" : "test",
    "enable_inject_operator_name_attribute" : true,
    "enable_message_authenticator_attribute" : true,
    "enable_permit_dynamic_authorization_message_change" : true,
    "retry_interval" : 60,
    "accounting_interim_update_interval" : 60,
    "entries" : [ {
      "server_role" : "PRIMARY",
      "server_type" : "EXTERNAL_RADIUS_SERVER",
      "radius_server_id" : 3
    } ]
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/radius-client-objects?page=1&limit=10' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNiwiZXhwIjoxNzEyNzc4OTI2fQ.XlCubs47IZDajOrRrv0U0cEw4Qwxm93r_FYT1R99qqY' \
    -H 'Content-Type: application/json'

Create RADIUS client object

POST /radius-client-objects

Request Fields

Path Type Description

name

String

The RADIUS client object configuration name

description

String

The RADIUS client object description.

enable_inject_operator_name_attribute

Boolean

The flag for enable inject operator name attribute.

enable_message_authenticator_attribute

Boolean

The flag for enable message authenticator attribute

enable_permit_dynamic_authorization_message_change

Boolean

The flag for enable permit dynamic authorization message change

retry_interval

Number

The retry interval, 60 - 100000000 seconds

accounting_interim_update_interval

Number

The accounting interim update interval, 60 - 100000000 seconds

entries[].server_role

String

The RADIUS client object entry role, Primary, Backup1, Backup2…

entries[].server_type

String

The entry server type: INTERNAL_RADIUS_SERVER, EXTERNAL_RADIUS_SERVER, INTERNAL_RADIUS_PROXY

entries[].radius_server_id

Number

The ID of the RADIUS server object, for EXTERNAL_RADIUS_SERVER please use the ID of external RADIUS server object. For INTERNAL_RADIUS_SERVER, please use the RADIUS device ID

HTTP Request

POST /radius-client-objects HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNiwiZXhwIjoxNzEyNzc4OTI2fQ.XlCubs47IZDajOrRrv0U0cEw4Qwxm93r_FYT1R99qqY
Content-Type: application/json
Content-Length: 426

{
  "name" : "RADIUS-CLIENT-OBJECT",
  "description" : "test",
  "enable_inject_operator_name_attribute" : true,
  "enable_message_authenticator_attribute" : true,
  "enable_permit_dynamic_authorization_message_change" : true,
  "retry_interval" : 60,
  "accounting_interim_update_interval" : 60,
  "entries" : [ {
    "server_role" : "PRIMARY",
    "server_type" : "EXTERNAL_RADIUS_SERVER",
    "radius_server_id" : 2
  } ]
}

Response Fields

Path Type Description

id

Number

The RADIUS client object ID.

create_time

String

The create time.

update_time

String

The last update time.

name

String

The RADIUS client object configuration name

description

String

The RADIUS client object description.

enable_inject_operator_name_attribute

Boolean

The flag for enable inject operator name attribute.

enable_message_authenticator_attribute

Boolean

The flag for enable message authenticator attribute

enable_permit_dynamic_authorization_message_change

Boolean

The flag for enable permit dynamic authorization message change

retry_interval

Number

The retry interval, 60 - 100000000 seconds

accounting_interim_update_interval

Number

The accounting interim update interval, 60 - 100000000 seconds

entries[].server_role

String

The RADIUS client object entry role, Primary, Backup1, Backup2…

entries[].server_type

String

The entry server type: INTERNAL_RADIUS_SERVER, EXTERNAL_RADIUS_SERVER, INTERNAL_RADIUS_PROXY

entries[].radius_server_id

Number

The RADIUS client object entry RADIUS server ID

HTTP Response

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

{
  "id" : 1,
  "create_time" : "2024-04-03T19:55:26.000+0000",
  "update_time" : "2024-04-03T19:55:26.000+0000",
  "name" : "RADIUS_CLIENT_OBJECT",
  "description" : "test",
  "enable_inject_operator_name_attribute" : true,
  "enable_message_authenticator_attribute" : true,
  "enable_permit_dynamic_authorization_message_change" : true,
  "retry_interval" : 60,
  "accounting_interim_update_interval" : 60,
  "entries" : [ {
    "server_role" : "PRIMARY",
    "server_type" : "EXTERNAL_RADIUS_SERVER",
    "radius_server_id" : 3
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/radius-client-objects' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNiwiZXhwIjoxNzEyNzc4OTI2fQ.XlCubs47IZDajOrRrv0U0cEw4Qwxm93r_FYT1R99qqY' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "RADIUS-CLIENT-OBJECT",
  "description" : "test",
  "enable_inject_operator_name_attribute" : true,
  "enable_message_authenticator_attribute" : true,
  "enable_permit_dynamic_authorization_message_change" : true,
  "retry_interval" : 60,
  "accounting_interim_update_interval" : 60,
  "entries" : [ {
    "server_role" : "PRIMARY",
    "server_type" : "EXTERNAL_RADIUS_SERVER",
    "radius_server_id" : 2
  } ]
}'

Get RADIUS client object

GET /radius-client-objects/{id}

Path parameters

Table 123. /radius-client-objects/{id}
Parameter	Description
`id`	The RADIUS client object ID

HTTP Request

GET /radius-client-objects/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNiwiZXhwIjoxNzEyNzc4OTI2fQ.XlCubs47IZDajOrRrv0U0cEw4Qwxm93r_FYT1R99qqY
Content-Type: application/json

Response Fields

Path Type Description

id

Number

The RADIUS client object ID.

create_time

String

The create time.

update_time

String

The last update time.

name

String

The RADIUS client object configuration name

description

String

The RADIUS client object description.

enable_inject_operator_name_attribute

Boolean

The flag for enable inject operator name attribute.

enable_message_authenticator_attribute

Boolean

The flag for enable message authenticator attribute

enable_permit_dynamic_authorization_message_change

Boolean

The flag for enable permit dynamic authorization message change

retry_interval

Number

The retry interval, 60 - 100000000 seconds

accounting_interim_update_interval

Number

The accounting interim update interval, 60 - 100000000 seconds

entries[].server_role

String

The RADIUS client object entry role, Primary, Backup1, Backup2…

entries[].server_type

String

The entry server type: INTERNAL_RADIUS_SERVER, EXTERNAL_RADIUS_SERVER, INTERNAL_RADIUS_PROXY

entries[].radius_server_id

Number

The RADIUS client object entry RADIUS server 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
Content-Length: 538
RateLimit-Remaining: 7414
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "id" : 1,
  "create_time" : "2024-04-03T19:55:26.000+0000",
  "update_time" : "2024-04-03T19:55:26.000+0000",
  "name" : "RADIUS_CLIENT_OBJECT",
  "description" : "test",
  "enable_inject_operator_name_attribute" : true,
  "enable_message_authenticator_attribute" : true,
  "enable_permit_dynamic_authorization_message_change" : true,
  "retry_interval" : 60,
  "accounting_interim_update_interval" : 60,
  "entries" : [ {
    "server_role" : "PRIMARY",
    "server_type" : "EXTERNAL_RADIUS_SERVER",
    "radius_server_id" : 3
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/radius-client-objects/438086664193' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNiwiZXhwIjoxNzEyNzc4OTI2fQ.XlCubs47IZDajOrRrv0U0cEw4Qwxm93r_FYT1R99qqY' \
    -H 'Content-Type: application/json'

Update RADIUS client object

PUT /radius-client-objects/{id}

Path Parameters

Table 124. /radius-client-objects/{id}
Parameter	Description
`id`	The external RADIUS server configuration ID

Request Fields

Path Type Description

name

String

The RADIUS client object configuration name

description

String

The RADIUS client object description.

enable_inject_operator_name_attribute

Boolean

The flag for enable inject operator name attribute.

enable_message_authenticator_attribute

Boolean

The flag for enable message authenticator attribute

enable_permit_dynamic_authorization_message_change

Boolean

The flag for enable permit dynamic authorization message change

retry_interval

Number

The retry interval, 60 - 100000000 seconds

accounting_interim_update_interval

Number

The accounting interim update interval, 60 - 100000000 seconds

HTTP Request

PUT /radius-client-objects/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNywiZXhwIjoxNzEyNzc4OTI3fQ.1ru2kSXseyxpWNEvOZngpAFGqi6HMnPa7HBwjiS4cH8
Host: api.extremecloudiq.com
Content-Length: 297
Content-Type: application/json

{
  "name" : "RADIUS-CLIENT-OBJECT",
  "description" : "test",
  "enable_inject_operator_name_attribute" : true,
  "enable_message_authenticator_attribute" : true,
  "enable_permit_dynamic_authorization_message_change" : true,
  "retry_interval" : 60,
  "accounting_interim_update_interval" : 60
}

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/radius-client-objects/438086664193' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNywiZXhwIjoxNzEyNzc4OTI3fQ.1ru2kSXseyxpWNEvOZngpAFGqi6HMnPa7HBwjiS4cH8' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "RADIUS-CLIENT-OBJECT",
  "description" : "test",
  "enable_inject_operator_name_attribute" : true,
  "enable_message_authenticator_attribute" : true,
  "enable_permit_dynamic_authorization_message_change" : true,
  "retry_interval" : 60,
  "accounting_interim_update_interval" : 60
}'

Delete RADIUS client object

DELETE /radius-client-objects/{id}

Path Parameters

Table 125. /radius-client-objects/{id}
Parameter	Description
`id`	The RADIUS client object entry ID.

HTTP Request

DELETE /radius-client-objects/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNiwiZXhwIjoxNzEyNzc4OTI2fQ.XlCubs47IZDajOrRrv0U0cEw4Qwxm93r_FYT1R99qqY
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: 7411
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/radius-client-objects/438086664193' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNiwiZXhwIjoxNzEyNzc4OTI2fQ.XlCubs47IZDajOrRrv0U0cEw4Qwxm93r_FYT1R99qqY' \
    -H 'Content-Type: application/json'

List RADIUS proxies

GET /radius-proxies

Request Parameters

Parameter Description

page

Page number

limit

Page size

HTTP Request

GET /radius-proxies?page=1&limit=10 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNywiZXhwIjoxNzEyNzc4OTI3fQ.1ru2kSXseyxpWNEvOZngpAFGqi6HMnPa7HBwjiS4cH8
Host: api.extremecloudiq.com
Content-Type: application/json

Response Fields

Path Type Description

page

Number

The current page number

count

Number

The element count of the current page

total_pages

Number

The total page number based on request page size

total_count

Number

The total element count

data[].id

Number

The RADIUS proxy ID

data[].create_time

String

The create time

data[].update_time

String

The last update time

data[].org_id

Number

The organization identifier, valid when enabling HIQ feature

data[].name

String

The RADIUS proxy name

data[].description

String

The RADIUS proxy description

data[].retry_count

Number

The retry count of RADIUS proxy

data[].retry_delay

Number

The retry delay of RADIUS proxy

data[].dead_time

Number

The dead time of RADIUS proxy

data[].format_type

String

The format type of RADIUS proxy

data[].enable_inject_operator_name_attribute

Boolean

Flag to enable inject operator name attribute

data[].clients[].id

Number

The associate RADIUS client ID

data[].clients[].description

String

The description for associate RADIUS client

data[].clients[].shared_secret

String

The shared secret for associate RADIUS client

data[].clients[].l3_address_profile_id

Number

The L3 address profile ID for associate RADIUS client

data[].realms[].id

Number

The RADIUS proxy realm ID

data[].realms[].name

String

The RADIUS proxy realm name

data[].realms[].enable_strip_realm_name

Boolean

Flag to enable strip realm name

data[].realms[].radius_client_object_id

Number

The associate RADIUS client object ID for RADIUS proxy realm

HTTP Response

HTTP/1.1 200 OK
Content-Length: 3560
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
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

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 1,
  "total_count" : 3,
  "data" : [ {
    "id" : 0,
    "create_time" : "2024-04-03T19:55:27.000+0000",
    "update_time" : "2024-04-03T19:55:27.000+0000",
    "org_id" : 0,
    "name" : "test-radius-proxy-0",
    "description" : "test-radius-proxy-description-0",
    "format_type" : "NT",
    "retry_count" : 4,
    "retry_delay" : 5,
    "dead_time" : 1000,
    "enable_inject_operator_name_attribute" : false,
    "clients" : [ {
      "id" : 438086664192,
      "shared_secret" : "kOstJVDNoT",
      "description" : "test-description-0",
      "l3_address_profile_id" : 0
    }, {
      "id" : 438086664193,
      "shared_secret" : "EvCLmpkgyf",
      "description" : "test-description-1",
      "l3_address_profile_id" : 1
    } ],
    "realms" : [ {
      "id" : 438086664192,
      "name" : "test-realm-0",
      "enable_strip_realm_name" : false,
      "radius_client_object_id" : 0
    }, {
      "id" : 438086664193,
      "name" : "test-realm-1",
      "enable_strip_realm_name" : false,
      "radius_client_object_id" : 1
    }, {
      "id" : 438086664194,
      "name" : "test-realm-2",
      "enable_strip_realm_name" : false,
      "radius_client_object_id" : 2
    } ]
  }, {
    "id" : 1,
    "create_time" : "2024-04-03T19:55:27.000+0000",
    "update_time" : "2024-04-03T19:55:27.000+0000",
    "org_id" : 0,
    "name" : "test-radius-proxy-1",
    "description" : "test-radius-proxy-description-1",
    "format_type" : "NT",
    "retry_count" : 4,
    "retry_delay" : 5,
    "dead_time" : 1000,
    "enable_inject_operator_name_attribute" : false,
    "clients" : [ {
      "id" : 438086664192,
      "shared_secret" : "WkuCvoOFdg",
      "description" : "test-description-0",
      "l3_address_profile_id" : 0
    }, {
      "id" : 438086664193,
      "shared_secret" : "hYxdfuonWp",
      "description" : "test-description-1",
      "l3_address_profile_id" : 1
    } ],
    "realms" : [ {
      "id" : 438086664192,
      "name" : "test-realm-0",
      "enable_strip_realm_name" : false,
      "radius_client_object_id" : 0
    }, {
      "id" : 438086664193,
      "name" : "test-realm-1",
      "enable_strip_realm_name" : false,
      "radius_client_object_id" : 1
    }, {
      "id" : 438086664194,
      "name" : "test-realm-2",
      "enable_strip_realm_name" : false,
      "radius_client_object_id" : 2
    } ]
  }, {
    "id" : 2,
    "create_time" : "2024-04-03T19:55:27.000+0000",
    "update_time" : "2024-04-03T19:55:27.000+0000",
    "org_id" : 0,
    "name" : "test-radius-proxy-2",
    "description" : "test-radius-proxy-description-2",
    "format_type" : "NT",
    "retry_count" : 4,
    "retry_delay" : 5,
    "dead_time" : 1000,
    "enable_inject_operator_name_attribute" : false,
    "clients" : [ {
      "id" : 438086664192,
      "shared_secret" : "FGQkRBuOek",
      "description" : "test-description-0",
      "l3_address_profile_id" : 0
    }, {
      "id" : 438086664193,
      "shared_secret" : "jwNBRmSAGx",
      "description" : "test-description-1",
      "l3_address_profile_id" : 1
    } ],
    "realms" : [ {
      "id" : 438086664192,
      "name" : "test-realm-0",
      "enable_strip_realm_name" : false,
      "radius_client_object_id" : 0
    }, {
      "id" : 438086664193,
      "name" : "test-realm-1",
      "enable_strip_realm_name" : false,
      "radius_client_object_id" : 1
    }, {
      "id" : 438086664194,
      "name" : "test-realm-2",
      "enable_strip_realm_name" : false,
      "radius_client_object_id" : 2
    } ]
  } ]
}

cURL Request

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

List RADIUS proxy devices

GET /radius-proxies/devices

Request Parameters

Parameter Description

page

Page number

limit

Page size

HTTP Request

GET /radius-proxies/devices?page=1&limit=10 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNiwiZXhwIjoxNzEyNzc4OTI2fQ.XlCubs47IZDajOrRrv0U0cEw4Qwxm93r_FYT1R99qqY
Content-Type: application/json

Response Fields

Path Type Description

page

Number

The current page number.

count

Number

The element count of the current page.

total_pages

Number

The total page number based on request page size.

total_count

Number

The total element count.

data[].id

Number

The inter RADIUS device ID used in RADIUS client object

data[].create_time

String

The create time.

data[].update_time

String

The last update time.

data[].org_id

Number

The organization identifier, valid when enabling HIQ feature.

data[].radius_server_id

Number

The internal RADIUS server id

data[].radius_server_name

String

The internal RADIUS server name

data[].host_name

String

The hostname of the RADIUS device

HTTP Response

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

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 2,
  "total_count" : 15,
  "data" : [ {
    "id" : 1,
    "create_time" : "2024-04-03T19:55:26.000+0000",
    "update_time" : "2024-04-03T19:55:26.000+0000",
    "org_id" : 10,
    "radius_server_id" : 100,
    "radius_server_name" : "test RADIUS name",
    "host_name" : "TEST ID"
  }, {
    "id" : 2,
    "create_time" : "2024-04-03T19:55:26.000+0000",
    "update_time" : "2024-04-03T19:55:26.000+0000",
    "org_id" : 10,
    "radius_server_id" : 100,
    "radius_server_name" : "test RADIUS name",
    "host_name" : "TEST ID"
  }, {
    "id" : 3,
    "create_time" : "2024-04-03T19:55:26.000+0000",
    "update_time" : "2024-04-03T19:55:26.000+0000",
    "org_id" : 10,
    "radius_server_id" : 100,
    "radius_server_name" : "test RADIUS name",
    "host_name" : "TEST ID"
  }, {
    "id" : 4,
    "create_time" : "2024-04-03T19:55:26.000+0000",
    "update_time" : "2024-04-03T19:55:26.000+0000",
    "org_id" : 10,
    "radius_server_id" : 100,
    "radius_server_name" : "test RADIUS name",
    "host_name" : "TEST ID"
  }, {
    "id" : 5,
    "create_time" : "2024-04-03T19:55:26.000+0000",
    "update_time" : "2024-04-03T19:55:26.000+0000",
    "org_id" : 10,
    "radius_server_id" : 100,
    "radius_server_name" : "test RADIUS name",
    "host_name" : "TEST ID"
  }, {
    "id" : 6,
    "create_time" : "2024-04-03T19:55:26.000+0000",
    "update_time" : "2024-04-03T19:55:26.000+0000",
    "org_id" : 10,
    "radius_server_id" : 100,
    "radius_server_name" : "test RADIUS name",
    "host_name" : "TEST ID"
  }, {
    "id" : 7,
    "create_time" : "2024-04-03T19:55:26.000+0000",
    "update_time" : "2024-04-03T19:55:26.000+0000",
    "org_id" : 10,
    "radius_server_id" : 100,
    "radius_server_name" : "test RADIUS name",
    "host_name" : "TEST ID"
  }, {
    "id" : 8,
    "create_time" : "2024-04-03T19:55:26.000+0000",
    "update_time" : "2024-04-03T19:55:26.000+0000",
    "org_id" : 10,
    "radius_server_id" : 100,
    "radius_server_name" : "test RADIUS name",
    "host_name" : "TEST ID"
  }, {
    "id" : 9,
    "create_time" : "2024-04-03T19:55:26.000+0000",
    "update_time" : "2024-04-03T19:55:26.000+0000",
    "org_id" : 10,
    "radius_server_id" : 100,
    "radius_server_name" : "test RADIUS name",
    "host_name" : "TEST ID"
  }, {
    "id" : 10,
    "create_time" : "2024-04-03T19:55:26.000+0000",
    "update_time" : "2024-04-03T19:55:26.000+0000",
    "org_id" : 10,
    "radius_server_id" : 100,
    "radius_server_name" : "test RADIUS name",
    "host_name" : "TEST ID"
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/radius-proxies/devices?page=1&limit=10' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNiwiZXhwIjoxNzEyNzc4OTI2fQ.XlCubs47IZDajOrRrv0U0cEw4Qwxm93r_FYT1R99qqY' \
    -H 'Content-Type: application/json'

Create RADIUS proxy

POST /radius-proxies

Request Fields

Path Type Description

name

String

The RADIUS proxy name

description

String

The RADIUS proxy description

retry_count

Number

The retry count of RADIUS proxy

retry_delay

Number

The retry delay of RADIUS proxy

dead_time

Number

The dead time of RADIUS proxy

format_type

String

The format type of RADIUS proxy

enable_inject_operator_name_attribute

Boolean

Flag to enable inject operator name attribute

device_ids

Array

The device IDs to assign current RADIUS proxy

clients[].id

Number

The associate RADIUS client ID

clients[].description

String

The description for associate RADIUS client

clients[].shared_secret

String

The shared secret for associate RADIUS client

clients[].l3_address_profile_id

Number

The L3 address profile ID for associate RADIUS client

realms[].id

Number

The RADIUS proxy realm ID

realms[].name

String

The RADIUS proxy realm name

realms[].enable_strip_realm_name

Boolean

Flag to enable strip realm name

realms[].radius_client_object_id

Number

The associate RADIUS client object ID for RADIUS proxy realm

HTTP Request

POST /radius-proxies HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNywiZXhwIjoxNzEyNzc4OTI3fQ.1ru2kSXseyxpWNEvOZngpAFGqi6HMnPa7HBwjiS4cH8
Host: api.extremecloudiq.com
Content-Type: application/json
Content-Length: 851

{
  "name" : "test-radius-proxy-1",
  "description" : "test-radius-proxy-description-1",
  "format_type" : "NT",
  "retry_count" : 4,
  "retry_delay" : 5,
  "dead_time" : 1000,
  "enable_inject_operator_name_attribute" : false,
  "clients" : [ {
    "shared_secret" : "nJuDztysDQ",
    "description" : "test-description-0",
    "l3_address_profile_id" : 0
  }, {
    "shared_secret" : "asQMwrpYTL",
    "description" : "test-description-1",
    "l3_address_profile_id" : 1
  } ],
  "realms" : [ {
    "name" : "test-realm-0",
    "enable_strip_realm_name" : false,
    "radius_client_object_id" : 0
  }, {
    "name" : "test-realm-1",
    "enable_strip_realm_name" : false,
    "radius_client_object_id" : 1
  }, {
    "name" : "test-realm-2",
    "enable_strip_realm_name" : false,
    "radius_client_object_id" : 2
  } ],
  "device_ids" : [ 1, 2 ]
}

Response Fields

Path Type Description

id

Number

The RADIUS proxy ID

create_time

String

The create time

update_time

String

The last update time

org_id

Number

The organization identifier, valid when enabling HIQ feature

name

String

The RADIUS proxy name

description

String

The RADIUS proxy description

retry_count

Number

The retry count of RADIUS proxy

retry_delay

Number

The retry delay of RADIUS proxy

dead_time

Number

The dead time of RADIUS proxy

format_type

String

The format type of RADIUS proxy

enable_inject_operator_name_attribute

Boolean

Flag to enable inject operator name attribute

clients[].id

Number

The associate RADIUS client ID

clients[].description

String

The description for associate RADIUS client

clients[].shared_secret

String

The shared secret for associate RADIUS client

clients[].l3_address_profile_id

Number

The L3 address profile ID for associate RADIUS client

realms[].id

Number

The RADIUS proxy realm ID

realms[].name

String

The RADIUS proxy realm name

realms[].enable_strip_realm_name

Boolean

Flag to enable strip realm name

realms[].radius_client_object_id

Number

The associate RADIUS client object ID for RADIUS proxy realm

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

{
  "id" : 1,
  "create_time" : "2024-04-03T19:55:27.000+0000",
  "update_time" : "2024-04-03T19:55:27.000+0000",
  "org_id" : 0,
  "name" : "test-radius-proxy-1",
  "description" : "test-radius-proxy-description-1",
  "format_type" : "NT",
  "retry_count" : 4,
  "retry_delay" : 5,
  "dead_time" : 1000,
  "enable_inject_operator_name_attribute" : false,
  "clients" : [ {
    "id" : 438086664192,
    "shared_secret" : "eYRzCTAclC",
    "description" : "test-description-0",
    "l3_address_profile_id" : 0
  }, {
    "id" : 438086664193,
    "shared_secret" : "YosyWFbpGN",
    "description" : "test-description-1",
    "l3_address_profile_id" : 1
  } ],
  "realms" : [ {
    "id" : 438086664192,
    "name" : "test-realm-0",
    "enable_strip_realm_name" : false,
    "radius_client_object_id" : 0
  }, {
    "id" : 438086664193,
    "name" : "test-realm-1",
    "enable_strip_realm_name" : false,
    "radius_client_object_id" : 1
  }, {
    "id" : 438086664194,
    "name" : "test-realm-2",
    "enable_strip_realm_name" : false,
    "radius_client_object_id" : 2
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/radius-proxies' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNywiZXhwIjoxNzEyNzc4OTI3fQ.1ru2kSXseyxpWNEvOZngpAFGqi6HMnPa7HBwjiS4cH8' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "test-radius-proxy-1",
  "description" : "test-radius-proxy-description-1",
  "format_type" : "NT",
  "retry_count" : 4,
  "retry_delay" : 5,
  "dead_time" : 1000,
  "enable_inject_operator_name_attribute" : false,
  "clients" : [ {
    "shared_secret" : "nJuDztysDQ",
    "description" : "test-description-0",
    "l3_address_profile_id" : 0
  }, {
    "shared_secret" : "asQMwrpYTL",
    "description" : "test-description-1",
    "l3_address_profile_id" : 1
  } ],
  "realms" : [ {
    "name" : "test-realm-0",
    "enable_strip_realm_name" : false,
    "radius_client_object_id" : 0
  }, {
    "name" : "test-realm-1",
    "enable_strip_realm_name" : false,
    "radius_client_object_id" : 1
  }, {
    "name" : "test-realm-2",
    "enable_strip_realm_name" : false,
    "radius_client_object_id" : 2
  } ],
  "device_ids" : [ 1, 2 ]
}'

Get RADIUS proxy

GET /radius-proxies/{id}

Path parameters

Table 126. /radius-proxies/{id}
Parameter	Description
`id`	The RADIUS proxy ID

HTTP Request

GET /radius-proxies/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNiwiZXhwIjoxNzEyNzc4OTI2fQ.XlCubs47IZDajOrRrv0U0cEw4Qwxm93r_FYT1R99qqY
Content-Type: application/json

Response Fields

Path Type Description

id

Number

The RADIUS proxy ID

create_time

String

The create time

update_time

String

The last update time

org_id

Number

The organization identifier, valid when enabling HIQ feature

name

String

The RADIUS proxy name

description

String

The RADIUS proxy description

retry_count

Number

The retry count of RADIUS proxy

retry_delay

Number

The retry delay of RADIUS proxy

dead_time

Number

The dead time of RADIUS proxy

format_type

String

The format type of RADIUS proxy

enable_inject_operator_name_attribute

Boolean

Flag to enable inject operator name attribute

clients[].id

Number

The associate RADIUS client ID

clients[].description

String

The description for associate RADIUS client

clients[].shared_secret

String

The shared secret for associate RADIUS client

clients[].l3_address_profile_id

Number

The L3 address profile ID for associate RADIUS client

realms[].id

Number

The RADIUS proxy realm ID

realms[].name

String

The RADIUS proxy realm name

realms[].enable_strip_realm_name

Boolean

Flag to enable strip realm name

realms[].radius_client_object_id

Number

The associate RADIUS client object ID for RADIUS proxy realm

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: 1077
X-Content-Type-Options: nosniff
RateLimit-Remaining: 7417
Content-Type: application/json;charset=UTF-8
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

{
  "id" : 1,
  "create_time" : "2024-04-03T19:55:26.000+0000",
  "update_time" : "2024-04-03T19:55:26.000+0000",
  "org_id" : 0,
  "name" : "test-radius-proxy-1",
  "description" : "test-radius-proxy-description-1",
  "format_type" : "NT",
  "retry_count" : 4,
  "retry_delay" : 5,
  "dead_time" : 1000,
  "enable_inject_operator_name_attribute" : false,
  "clients" : [ {
    "id" : 438086664192,
    "shared_secret" : "ILQkVRpndH",
    "description" : "test-description-0",
    "l3_address_profile_id" : 0
  }, {
    "id" : 438086664193,
    "shared_secret" : "iVMRLrIomy",
    "description" : "test-description-1",
    "l3_address_profile_id" : 1
  } ],
  "realms" : [ {
    "id" : 438086664192,
    "name" : "test-realm-0",
    "enable_strip_realm_name" : false,
    "radius_client_object_id" : 0
  }, {
    "id" : 438086664193,
    "name" : "test-realm-1",
    "enable_strip_realm_name" : false,
    "radius_client_object_id" : 1
  }, {
    "id" : 438086664194,
    "name" : "test-realm-2",
    "enable_strip_realm_name" : false,
    "radius_client_object_id" : 2
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/radius-proxies/438086664193' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNiwiZXhwIjoxNzEyNzc4OTI2fQ.XlCubs47IZDajOrRrv0U0cEw4Qwxm93r_FYT1R99qqY' \
    -H 'Content-Type: application/json'

Update RADIUS proxy

PUT /radius-proxies/{id}

Path Parameters

Table 127. /radius-proxies/{id}
Parameter	Description
`id`	The RADIUS proxy configuration ID

Request Fields

Path Type Description

name

String

The RADIUS proxy name

description

String

The RADIUS proxy description

retry_count

Number

The retry count of RADIUS proxy

retry_delay

Number

The retry delay of RADIUS proxy

dead_time

Number

The dead time of RADIUS proxy

format_type

String

The format type of RADIUS proxy

enable_inject_operator_name_attribute

Boolean

Flag to enable inject operator name attribute

clients[].id

Number

The associate RADIUS client ID

clients[].description

String

The description for associate RADIUS client

clients[].shared_secret

String

The shared secret for associate RADIUS client

clients[].l3_address_profile_id

Number

The L3 address profile ID for associate RADIUS client

realms[].id

Number

The RADIUS proxy realm ID

realms[].name

String

The RADIUS proxy realm name

realms[].enable_strip_realm_name

Boolean

Flag to enable strip realm name

realms[].radius_client_object_id

Number

The associate RADIUS client object ID for RADIUS proxy realm

HTTP Request

PUT /radius-proxies/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNiwiZXhwIjoxNzEyNzc4OTI2fQ.XlCubs47IZDajOrRrv0U0cEw4Qwxm93r_FYT1R99qqY
Content-Type: application/json
Content-Length: 971

{
  "name" : "test-radius-proxy-438086664193",
  "description" : "test-radius-proxy-description-438086664193",
  "format_type" : "NT",
  "retry_count" : 4,
  "retry_delay" : 5,
  "dead_time" : 1000,
  "enable_inject_operator_name_attribute" : false,
  "clients" : [ {
    "id" : 438086664192,
    "shared_secret" : "btUsaTkdda",
    "description" : "test-description-0",
    "l3_address_profile_id" : 0
  }, {
    "id" : 438086664193,
    "shared_secret" : "NADYNNBpFO",
    "description" : "test-description-1",
    "l3_address_profile_id" : 1
  } ],
  "realms" : [ {
    "id" : 438086664192,
    "name" : "test-realm-0",
    "enable_strip_realm_name" : false,
    "radius_client_object_id" : 0
  }, {
    "id" : 438086664193,
    "name" : "test-realm-1",
    "enable_strip_realm_name" : false,
    "radius_client_object_id" : 1
  }, {
    "id" : 438086664194,
    "name" : "test-realm-2",
    "enable_strip_realm_name" : false,
    "radius_client_object_id" : 2
  } ]
}

Response Fields

Path Type Description

id

Number

The RADIUS proxy ID

create_time

String

The create time

update_time

String

The last update time

org_id

Number

The organization identifier, valid when enabling HIQ feature

name

String

The RADIUS proxy name

description

String

The RADIUS proxy description

retry_count

Number

The retry count of RADIUS proxy

retry_delay

Number

The retry delay of RADIUS proxy

dead_time

Number

The dead time of RADIUS proxy

format_type

String

The format type of RADIUS proxy

enable_inject_operator_name_attribute

Boolean

Flag to enable inject operator name attribute

clients[].id

Number

The associate RADIUS client ID

clients[].description

String

The description for associate RADIUS client

clients[].shared_secret

String

The shared secret for associate RADIUS client

clients[].l3_address_profile_id

Number

The L3 address profile ID for associate RADIUS client

realms[].id

Number

The RADIUS proxy realm ID

realms[].name

String

The RADIUS proxy realm name

realms[].enable_strip_realm_name

Boolean

Flag to enable strip realm name

realms[].radius_client_object_id

Number

The associate RADIUS client object ID for RADIUS proxy realm

HTTP Response

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

{
  "id" : 1,
  "create_time" : "2024-04-03T19:55:26.000+0000",
  "update_time" : "2024-04-03T19:55:26.000+0000",
  "org_id" : 0,
  "name" : "test-radius-proxy-1",
  "description" : "test-radius-proxy-description-1",
  "format_type" : "NT",
  "retry_count" : 4,
  "retry_delay" : 5,
  "dead_time" : 1000,
  "enable_inject_operator_name_attribute" : false,
  "clients" : [ {
    "id" : 438086664192,
    "shared_secret" : "zBrkzfVMBa",
    "description" : "test-description-0",
    "l3_address_profile_id" : 0
  }, {
    "id" : 438086664193,
    "shared_secret" : "bQszBCSeOK",
    "description" : "test-description-1",
    "l3_address_profile_id" : 1
  } ],
  "realms" : [ {
    "id" : 438086664192,
    "name" : "test-realm-0",
    "enable_strip_realm_name" : false,
    "radius_client_object_id" : 0
  }, {
    "id" : 438086664193,
    "name" : "test-realm-1",
    "enable_strip_realm_name" : false,
    "radius_client_object_id" : 1
  }, {
    "id" : 438086664194,
    "name" : "test-realm-2",
    "enable_strip_realm_name" : false,
    "radius_client_object_id" : 2
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/radius-proxies/438086664193' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNiwiZXhwIjoxNzEyNzc4OTI2fQ.XlCubs47IZDajOrRrv0U0cEw4Qwxm93r_FYT1R99qqY' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "test-radius-proxy-438086664193",
  "description" : "test-radius-proxy-description-438086664193",
  "format_type" : "NT",
  "retry_count" : 4,
  "retry_delay" : 5,
  "dead_time" : 1000,
  "enable_inject_operator_name_attribute" : false,
  "clients" : [ {
    "id" : 438086664192,
    "shared_secret" : "btUsaTkdda",
    "description" : "test-description-0",
    "l3_address_profile_id" : 0
  }, {
    "id" : 438086664193,
    "shared_secret" : "NADYNNBpFO",
    "description" : "test-description-1",
    "l3_address_profile_id" : 1
  } ],
  "realms" : [ {
    "id" : 438086664192,
    "name" : "test-realm-0",
    "enable_strip_realm_name" : false,
    "radius_client_object_id" : 0
  }, {
    "id" : 438086664193,
    "name" : "test-realm-1",
    "enable_strip_realm_name" : false,
    "radius_client_object_id" : 1
  }, {
    "id" : 438086664194,
    "name" : "test-realm-2",
    "enable_strip_realm_name" : false,
    "radius_client_object_id" : 2
  } ]
}'

Delete RADIUS proxy

DELETE /radius-proxies/{id}

Path Parameters

Table 128. /radius-proxies/{id}
Parameter	Description
`id`	The RADIUS proxy configuration ID

HTTP Request

DELETE /radius-proxies/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNiwiZXhwIjoxNzEyNzc4OTI2fQ.XlCubs47IZDajOrRrv0U0cEw4Qwxm93r_FYT1R99qqY
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: 7418
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/radius-proxies/438086664193' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNiwiZXhwIjoxNzEyNzc4OTI2fQ.XlCubs47IZDajOrRrv0U0cEw4Qwxm93r_FYT1R99qqY' \
    -H 'Content-Type: application/json'

List external RADIUS servers

GET /radius-servers/external

Request Parameters

Parameter Description

page

Page number

limit

Page size

HTTP Request

GET /radius-servers/external?page=1&limit=10 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNiwiZXhwIjoxNzEyNzc4OTI2fQ.XlCubs47IZDajOrRrv0U0cEw4Qwxm93r_FYT1R99qqY
Content-Type: application/json

Response Fields

Path Type Description

page

Number

The current page number.

count

Number

The element count of the current page.

total_pages

Number

The total page number based on request page size.

total_count

Number

The total element count.

data[].id

Number

The external RADIUS server ID.

data[].create_time

String

The create time.

data[].update_time

String

The last update time.

data[].org_id

Number

The organization identifier, valid when enabling HIQ feature.

data[].name

String

The external RADIUS server configuration name

data[].authentication_port

Number

The authentication port in the configuration

data[].accounting_port

Number

The accounting port in the configuration.

data[].server_type

String

The external RADIUS server type, can be either ACCOUNTING, AUTHENTICATION, or BOTH

data[].shared_secret

String

The shared secret to connect to the RADIUS server

data[].enable_a3

Boolean

Indicates whether this is an Extreme A3 RADIUS server or not, cannot be updated after creation. Please set it to false if it is not an Extreme A3 RADIUS server.

data[].ip_address

String

The IPv4 address or Hostname of the RADIUS server

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: 7412
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: 3791

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 2,
  "total_count" : 15,
  "data" : [ {
    "id" : 1,
    "create_time" : "2024-04-03T19:55:26.000+0000",
    "update_time" : "2024-04-03T19:55:26.000+0000",
    "org_id" : 10,
    "name" : "external_radius_server0",
    "shared_secret" : "BKxtQ7O7WV",
    "authentication_port" : 1812,
    "accounting_port" : 1813,
    "server_type" : "BOTH",
    "ip_address" : "10.10.10.10",
    "enable_a3" : false
  }, {
    "id" : 2,
    "create_time" : "2024-04-03T19:55:26.000+0000",
    "update_time" : "2024-04-03T19:55:26.000+0000",
    "org_id" : 10,
    "name" : "external_radius_server1",
    "shared_secret" : "BKxtQ7O7WV",
    "authentication_port" : 1812,
    "accounting_port" : 1813,
    "server_type" : "BOTH",
    "ip_address" : "10.10.10.10",
    "enable_a3" : false
  }, {
    "id" : 3,
    "create_time" : "2024-04-03T19:55:26.000+0000",
    "update_time" : "2024-04-03T19:55:26.000+0000",
    "org_id" : 10,
    "name" : "external_radius_server2",
    "shared_secret" : "BKxtQ7O7WV",
    "authentication_port" : 1812,
    "accounting_port" : 1813,
    "server_type" : "BOTH",
    "ip_address" : "10.10.10.10",
    "enable_a3" : false
  }, {
    "id" : 4,
    "create_time" : "2024-04-03T19:55:26.000+0000",
    "update_time" : "2024-04-03T19:55:26.000+0000",
    "org_id" : 10,
    "name" : "external_radius_server3",
    "shared_secret" : "BKxtQ7O7WV",
    "authentication_port" : 1812,
    "accounting_port" : 1813,
    "server_type" : "BOTH",
    "ip_address" : "10.10.10.10",
    "enable_a3" : false
  }, {
    "id" : 5,
    "create_time" : "2024-04-03T19:55:26.000+0000",
    "update_time" : "2024-04-03T19:55:26.000+0000",
    "org_id" : 10,
    "name" : "external_radius_server4",
    "shared_secret" : "BKxtQ7O7WV",
    "authentication_port" : 1812,
    "accounting_port" : 1813,
    "server_type" : "BOTH",
    "ip_address" : "10.10.10.10",
    "enable_a3" : false
  }, {
    "id" : 6,
    "create_time" : "2024-04-03T19:55:26.000+0000",
    "update_time" : "2024-04-03T19:55:26.000+0000",
    "org_id" : 10,
    "name" : "external_radius_server5",
    "shared_secret" : "BKxtQ7O7WV",
    "authentication_port" : 1812,
    "accounting_port" : 1813,
    "server_type" : "BOTH",
    "ip_address" : "10.10.10.10",
    "enable_a3" : false
  }, {
    "id" : 7,
    "create_time" : "2024-04-03T19:55:26.000+0000",
    "update_time" : "2024-04-03T19:55:26.000+0000",
    "org_id" : 10,
    "name" : "external_radius_server6",
    "shared_secret" : "BKxtQ7O7WV",
    "authentication_port" : 1812,
    "accounting_port" : 1813,
    "server_type" : "BOTH",
    "ip_address" : "10.10.10.10",
    "enable_a3" : false
  }, {
    "id" : 8,
    "create_time" : "2024-04-03T19:55:26.000+0000",
    "update_time" : "2024-04-03T19:55:26.000+0000",
    "org_id" : 10,
    "name" : "external_radius_server7",
    "shared_secret" : "BKxtQ7O7WV",
    "authentication_port" : 1812,
    "accounting_port" : 1813,
    "server_type" : "BOTH",
    "ip_address" : "10.10.10.10",
    "enable_a3" : false
  }, {
    "id" : 9,
    "create_time" : "2024-04-03T19:55:26.000+0000",
    "update_time" : "2024-04-03T19:55:26.000+0000",
    "org_id" : 10,
    "name" : "external_radius_server8",
    "shared_secret" : "BKxtQ7O7WV",
    "authentication_port" : 1812,
    "accounting_port" : 1813,
    "server_type" : "BOTH",
    "ip_address" : "10.10.10.10",
    "enable_a3" : false
  }, {
    "id" : 10,
    "create_time" : "2024-04-03T19:55:26.000+0000",
    "update_time" : "2024-04-03T19:55:26.000+0000",
    "org_id" : 10,
    "name" : "external_radius_server9",
    "shared_secret" : "BKxtQ7O7WV",
    "authentication_port" : 1812,
    "accounting_port" : 1813,
    "server_type" : "BOTH",
    "ip_address" : "10.10.10.10",
    "enable_a3" : false
  } ]
}

cURL Request

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

Create external RADIUS server

POST /radius-servers/external

Request Fields

Path Type Description

name

String

The external RADIUS server configuration name

authentication_port

Number

The authentication port in the configuration

accounting_port

Number

The accounting port in the configuration.

server_type

String

The external RADIUS server type, can be either ACCOUNTING, AUTHENTICATION, or BOTH

shared_secret

String

The shared secret to connect to the RADIUS server

enable_a3

Boolean

Indicates whether this is an Extreme A3 RADIUS server or not, cannot be updated after creation. Please set it to false if it is not an Extreme A3 RADIUS server.

ip_addr

String

The IPv4 address or Hostname of the RADIUS server

HTTP Request

POST /radius-servers/external HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNywiZXhwIjoxNzEyNzc4OTI3fQ.1ru2kSXseyxpWNEvOZngpAFGqi6HMnPa7HBwjiS4cH8
Host: api.extremecloudiq.com
Content-Type: application/json
Content-Length: 211

{
  "name" : "external-RADIUS-server",
  "shared_secret" : "BKxtQ7O7WV",
  "authentication_port" : 1812,
  "accounting_port" : 1813,
  "server_type" : "BOTH",
  "ip_addr" : "10.10.10.10",
  "enable_a3" : false
}

Response Fields

Path Type Description

id

Number

The external RADIUS server ID.

create_time

String

The create time.

update_time

String

The last update time.

org_id

Number

The organization identifier, valid when enabling HIQ feature.

name

String

The external RADIUS server configuration name

authentication_port

Number

The authentication port in the configuration

accounting_port

Number

The accounting port in the configuration.

server_type

String

The external RADIUS server type, can be either ACCOUNTING, AUTHENTICATION, or BOTH

shared_secret

String

The shared secret to connect to the RADIUS server

ip_address

String

The IPv4 address or Hostname of the RADIUS server

enable_a3

Boolean

Indicates whether this is an Extreme A3 RADIUS server or not, cannot be updated after creation. Please set it to false if it is not an Extreme A3 RADIUS server.

HTTP Response

HTTP/1.1 201 Created
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
RateLimit-Remaining: 7403
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: 344

{
  "id" : 1,
  "create_time" : "2024-04-03T19:55:27.000+0000",
  "update_time" : "2024-04-03T19:55:27.000+0000",
  "org_id" : 10,
  "name" : "external_radius_server1",
  "shared_secret" : "BKxtQ7O7WV",
  "authentication_port" : 1812,
  "accounting_port" : 1813,
  "server_type" : "BOTH",
  "ip_address" : "10.10.10.10",
  "enable_a3" : false
}

cURL Request

$ curl 'https://api.extremecloudiq.com/radius-servers/external' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNywiZXhwIjoxNzEyNzc4OTI3fQ.1ru2kSXseyxpWNEvOZngpAFGqi6HMnPa7HBwjiS4cH8' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "external-RADIUS-server",
  "shared_secret" : "BKxtQ7O7WV",
  "authentication_port" : 1812,
  "accounting_port" : 1813,
  "server_type" : "BOTH",
  "ip_addr" : "10.10.10.10",
  "enable_a3" : false
}'

List external RADIUS server

GET /radius-servers/external/{id}

Path Parameters

Table 129. /radius-servers/external/{id}
Parameter	Description
`id`	The external RADIUS server ID

HTTP Request

GET /radius-servers/external/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNSwiZXhwIjoxNzEyNzc4OTI1fQ.eU5MJBEF1MpHvs0P5s0dRBd9fAP3KR6HgKhx35JLG-U
Content-Type: application/json

Response Fields

Path Type Description

id

Number

The external RADIUS server ID.

create_time

String

The create time.

update_time

String

The last update time.

org_id

Number

The organization identifier, valid when enabling HIQ feature.

name

String

The external RADIUS server configuration name

authentication_port

Number

The authentication port in the configuration

accounting_port

Number

The accounting port in the configuration.

server_type

String

The external RADIUS server type, can be either ACCOUNTING, AUTHENTICATION, or BOTH

shared_secret

String

The shared secret to connect to the RADIUS server

ip_address

String

The IPv4 address or Hostname of the RADIUS server

enable_a3

Boolean

Indicates whether this is an Extreme A3 RADIUS server or not, cannot be updated after creation. Please set it to false if it is not an Extreme A3 RADIUS server.

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Remaining: 7420
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: 343

{
  "id" : 1,
  "create_time" : "2024-04-03T19:55:25.000+0000",
  "update_time" : "2024-04-03T19:55:25.000+0000",
  "org_id" : 10,
  "name" : "external_radius_server1",
  "shared_secret" : "BKxtQ7O7WV",
  "authentication_port" : 1812,
  "accounting_port" : 1813,
  "server_type" : "BOTH",
  "ip_address" : "10.10.10.10",
  "enable_a3" : true
}

cURL Request

$ curl 'https://api.extremecloudiq.com/radius-servers/external/438086664193' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNSwiZXhwIjoxNzEyNzc4OTI1fQ.eU5MJBEF1MpHvs0P5s0dRBd9fAP3KR6HgKhx35JLG-U' \
    -H 'Content-Type: application/json'

Update external RADIUS server

PUT /radius-servers/external/{id}

Path Parameters

Table 130. /radius-servers/external/{id}
Parameter	Description
`id`	The external RADIUS server configuration ID

Request Fields

Path Type Description

name

String

The external RADIUS server configuration name

authentication_port

Number

The authentication port in the configuration

accounting_port

Number

The accounting port in the configuration.

shared_secret

String

The shared secret to connect to the RADIUS server

server_type

String

The external RADIUS server type, can be either ACCOUNTING, AUTHENTICATION, or BOTH. Port cannot be disabled once created, so only update to BOTH is allowed

ip_addr

String

The IPv4 address or Hostname of the RADIUS server

HTTP Request

PUT /radius-servers/external/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNiwiZXhwIjoxNzEyNzc4OTI2fQ.XlCubs47IZDajOrRrv0U0cEw4Qwxm93r_FYT1R99qqY
Content-Type: application/json
Content-Length: 188

{
  "name" : "external-RADIUS-server",
  "shared_secret" : "BKxtQ7O7WV",
  "authentication_port" : 1812,
  "accounting_port" : 1813,
  "server_type" : "BOTH",
  "ip_addr" : "10.10.10.10"
}

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: 7409

cURL Request

$ curl 'https://api.extremecloudiq.com/radius-servers/external/438086664193' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNiwiZXhwIjoxNzEyNzc4OTI2fQ.XlCubs47IZDajOrRrv0U0cEw4Qwxm93r_FYT1R99qqY' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "external-RADIUS-server",
  "shared_secret" : "BKxtQ7O7WV",
  "authentication_port" : 1812,
  "accounting_port" : 1813,
  "server_type" : "BOTH",
  "ip_addr" : "10.10.10.10"
}'

Delete external RADIUS server

DELETE /radius-servers/external/{id}

Path Parameters

Table 131. /radius-servers/external/{id}
Parameter	Description
`id`	The external RADIUS server configuration ID

HTTP Request

DELETE /radius-servers/external/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNiwiZXhwIjoxNzEyNzc4OTI2fQ.XlCubs47IZDajOrRrv0U0cEw4Qwxm93r_FYT1R99qqY
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
RateLimit-Remaining: 7419
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

cURL Request

$ curl 'https://api.extremecloudiq.com/radius-servers/external/438086664193' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNiwiZXhwIjoxNzEyNzc4OTI2fQ.XlCubs47IZDajOrRrv0U0cEw4Qwxm93r_FYT1R99qqY' \
    -H 'Content-Type: application/json'

List internal RADIUS servers

GET /radius-servers/internal

Request Parameters

Parameter Description

page

Page number

limit

Page size

HTTP Request

GET /radius-servers/internal?page=1&limit=10 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNiwiZXhwIjoxNzEyNzc4OTI2fQ.XlCubs47IZDajOrRrv0U0cEw4Qwxm93r_FYT1R99qqY
Content-Type: application/json

Response Fields

Path Type Description

page

Number

The current page number.

count

Number

The element count of the current page.

total_pages

Number

The total page number based on request page size.

total_count

Number

The total element count.

data[].id

Number

The internal RADIUS server ID.

data[].create_time

String

The create time.

data[].update_time

String

The last update time.

data[].org_id

Number

The organization identifier, valid when enabling HIQ feature.

data[].name

String

The internal RADIUS server configuration name

data[].description

String

The internal RADIUS server configuration description

data[].authentication_method_group

String

The authentication group, CO_AUTHENTICATION_METHOD_GROUP_TLS_PEAP_TTLS_LEAP_MD5 CO_AUTHENTICATION_METHOD_GROUP_TLS_PEAP_TTLS_LEAP CO_AUTHENTICATION_METHOD_GROUP_TLS_PEAP CO_AUTHENTICATION_METHOD_GROUP_TLS_TTLS CO_AUTHENTICATION_METHOD_GROUP_TLS CO_AUTHENTICATION_METHOD_GROUP_LEAP

data[].default_authentication_method

String

The default authentication method, CO_AUTHENTICATION_METHOD_TLS CO_AUTHENTICATION_METHOD_PEAP CO_AUTHENTICATION_METHOD_TTLS CO_AUTHENTICATION_METHOD_LEAP CO_AUTHENTICATION_METHOD_MD5

data[].enable_verify_server_cert

Boolean

Enable verify server cert or not

data[].server_key_password

String

password for server key

data[].enable_check_cert_common_name

Boolean

Enable check cert common name or not.

data[].enable_check_user_for_tls_auth

Boolean

Enable check user for TLS auth or not

data[].enable_check_user_for_peap_auth

Boolean

Enable check user for PEAP auth or not,for Active Directory as the external user directory only

data[].enable_check_user_for_ttls_auth

Boolean

Enable check user for TLS auth or not,for Active Directory as the external user directory only

data[].enable_authentication_server

Boolean

Enable the RADIUS server as authentication or not

data[].enable_radius_accounting_settings

Boolean

Enable the RADIUS server as accounting or not, must enable authentication server if want to enable accounting settings

data[].authentication_server_port

Number

Port for the authentication, must enable authentication. Max:65535, Min:1

data[].active_session_limit

Number

Active session limit, must enable accounting setting. Max:15, Min:0

data[].active_session_age_timeout

Number

Active session age timeout in seconds, must enable accounting setting. Max:300000000, Min:0

data[].ca_certificate_id

Number

The CA certificate ID

data[].server_certificate_id

Number

The Server certificate ID

data[].server_key_id

Number

The Server key ID

data[].device_ids

Array

The list of device ID associated with the internal RADIUS server

data[].clients[].id

Number

The associate RADIUS client ID

data[].clients[].description

String

The description for associate RADIUS client

data[].clients[].shared_secret

String

The shared secret for associate RADIUS client

data[].clients[].l3_address_profile_id

Number

The L3 address profile ID for associate RADIUS client

data[].external_user_directory.ldap_retry_interval

Number

Retry the previously unresponsive primary server after the specified seconds

data[].external_user_directory.local_check_interval

Number

Time to user local cache if none of the external servers are reachable in seconds

data[].external_user_directory.remote_check_interval

Number

Try the next backup server after specified seconds

data[].external_user_directory.enable_radius_server_credential_caching

Boolean

Caching credentials allows for better performance and higher availability by reducing the dependence on RADIUS servers across high-latency WAN links.

data[].external_user_directory.cache_lifetime

Number

Retain Cache for specified seconds

data[].external_user_directory.user_group_attribute

String

The user group attribute

data[].external_user_directory.external_user_directory_type

String

CO_EXTERNAL_USER_DIRECTORY_TYPE_OPEN_LDAP or CO_EXTERNAL_USER_DIRECTORY_TYPE_ACTIVE_DIRECTORY

data[].external_user_directory.entries[].default_server_id

Number

The default external user directory server id

data[].external_user_directory.entries[].server_role

String

The server role, Primary or Backup

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: 7417
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: 16681

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 2,
  "total_count" : 15,
  "data" : [ {
    "id" : 1,
    "create_time" : "2024-04-03T19:55:26.000+0000",
    "update_time" : "2024-04-03T19:55:26.000+0000",
    "org_id" : 10,
    "name" : "internal_radius_server0",
    "description" : "test list",
    "authentication_method_group" : "LEAP",
    "default_authentication_method" : "LEAP",
    "enable_verify_server_cert" : true,
    "server_key_password" : "BKxtQ7O7WV",
    "enable_check_cert_common_name" : true,
    "enable_check_user_for_tls_auth" : true,
    "enable_check_user_for_peap_auth" : true,
    "enable_check_user_for_ttls_auth" : true,
    "enable_authentication_server" : true,
    "enable_radius_accounting_settings" : true,
    "authentication_server_port" : 1812,
    "active_session_limit" : 0,
    "active_session_age_timeout" : 60,
    "external_user_directory" : {
      "ldap_retry_interval" : 600,
      "local_check_interval" : 300,
      "remote_check_interval" : 30,
      "enable_radius_server_credential_caching" : true,
      "cache_lifetime" : 86400,
      "user_group_attribute" : "radiusGroupName",
      "external_user_directory_type" : "ACTIVE_DIRECTORY",
      "entries" : [ {
        "default_server_id" : 1,
        "server_role" : "PRIMARY"
      } ]
    },
    "ca_certificate_id" : 2,
    "server_certificate_id" : 3,
    "server_key_id" : 4,
    "device_ids" : [ 1, 2, 3 ],
    "clients" : [ {
      "id" : 438086664192,
      "shared_secret" : "oLJjrPGCVK",
      "description" : "test-description-0",
      "l3_address_profile_id" : 0
    }, {
      "id" : 438086664193,
      "shared_secret" : "HLlMsXpWJt",
      "description" : "test-description-1",
      "l3_address_profile_id" : 1
    } ]
  }, {
    "id" : 2,
    "create_time" : "2024-04-03T19:55:26.000+0000",
    "update_time" : "2024-04-03T19:55:26.000+0000",
    "org_id" : 10,
    "name" : "internal_radius_server1",
    "description" : "test list",
    "authentication_method_group" : "LEAP",
    "default_authentication_method" : "LEAP",
    "enable_verify_server_cert" : true,
    "server_key_password" : "BKxtQ7O7WV",
    "enable_check_cert_common_name" : true,
    "enable_check_user_for_tls_auth" : true,
    "enable_check_user_for_peap_auth" : true,
    "enable_check_user_for_ttls_auth" : true,
    "enable_authentication_server" : true,
    "enable_radius_accounting_settings" : true,
    "authentication_server_port" : 1812,
    "active_session_limit" : 0,
    "active_session_age_timeout" : 60,
    "external_user_directory" : {
      "ldap_retry_interval" : 600,
      "local_check_interval" : 300,
      "remote_check_interval" : 30,
      "enable_radius_server_credential_caching" : true,
      "cache_lifetime" : 86400,
      "user_group_attribute" : "radiusGroupName",
      "external_user_directory_type" : "ACTIVE_DIRECTORY",
      "entries" : [ {
        "default_server_id" : 1,
        "server_role" : "PRIMARY"
      } ]
    },
    "ca_certificate_id" : 2,
    "server_certificate_id" : 3,
    "server_key_id" : 4,
    "device_ids" : [ 1, 2, 3 ],
    "clients" : [ {
      "id" : 438086664192,
      "shared_secret" : "zGZWOZJBnU",
      "description" : "test-description-0",
      "l3_address_profile_id" : 0
    }, {
      "id" : 438086664193,
      "shared_secret" : "XbGMkKGfpk",
      "description" : "test-description-1",
      "l3_address_profile_id" : 1
    } ]
  }, {
    "id" : 3,
    "create_time" : "2024-04-03T19:55:26.000+0000",
    "update_time" : "2024-04-03T19:55:26.000+0000",
    "org_id" : 10,
    "name" : "internal_radius_server2",
    "description" : "test list",
    "authentication_method_group" : "LEAP",
    "default_authentication_method" : "LEAP",
    "enable_verify_server_cert" : true,
    "server_key_password" : "BKxtQ7O7WV",
    "enable_check_cert_common_name" : true,
    "enable_check_user_for_tls_auth" : true,
    "enable_check_user_for_peap_auth" : true,
    "enable_check_user_for_ttls_auth" : true,
    "enable_authentication_server" : true,
    "enable_radius_accounting_settings" : true,
    "authentication_server_port" : 1812,
    "active_session_limit" : 0,
    "active_session_age_timeout" : 60,
    "external_user_directory" : {
      "ldap_retry_interval" : 600,
      "local_check_interval" : 300,
      "remote_check_interval" : 30,
      "enable_radius_server_credential_caching" : true,
      "cache_lifetime" : 86400,
      "user_group_attribute" : "radiusGroupName",
      "external_user_directory_type" : "ACTIVE_DIRECTORY",
      "entries" : [ {
        "default_server_id" : 1,
        "server_role" : "PRIMARY"
      } ]
    },
    "ca_certificate_id" : 2,
    "server_certificate_id" : 3,
    "server_key_id" : 4,
    "device_ids" : [ 1, 2, 3 ],
    "clients" : [ {
      "id" : 438086664192,
      "shared_secret" : "XtlbgJgIqk",
      "description" : "test-description-0",
      "l3_address_profile_id" : 0
    }, {
      "id" : 438086664193,
      "shared_secret" : "ZrlzzhDqfC",
      "description" : "test-description-1",
      "l3_address_profile_id" : 1
    } ]
  }, {
    "id" : 4,
    "create_time" : "2024-04-03T19:55:26.000+0000",
    "update_time" : "2024-04-03T19:55:26.000+0000",
    "org_id" : 10,
    "name" : "internal_radius_server3",
    "description" : "test list",
    "authentication_method_group" : "LEAP",
    "default_authentication_method" : "LEAP",
    "enable_verify_server_cert" : true,
    "server_key_password" : "BKxtQ7O7WV",
    "enable_check_cert_common_name" : true,
    "enable_check_user_for_tls_auth" : true,
    "enable_check_user_for_peap_auth" : true,
    "enable_check_user_for_ttls_auth" : true,
    "enable_authentication_server" : true,
    "enable_radius_accounting_settings" : true,
    "authentication_server_port" : 1812,
    "active_session_limit" : 0,
    "active_session_age_timeout" : 60,
    "external_user_directory" : {
      "ldap_retry_interval" : 600,
      "local_check_interval" : 300,
      "remote_check_interval" : 30,
      "enable_radius_server_credential_caching" : true,
      "cache_lifetime" : 86400,
      "user_group_attribute" : "radiusGroupName",
      "external_user_directory_type" : "ACTIVE_DIRECTORY",
      "entries" : [ {
        "default_server_id" : 1,
        "server_role" : "PRIMARY"
      } ]
    },
    "ca_certificate_id" : 2,
    "server_certificate_id" : 3,
    "server_key_id" : 4,
    "device_ids" : [ 1, 2, 3 ],
    "clients" : [ {
      "id" : 438086664192,
      "shared_secret" : "XPmJzDXXnn",
      "description" : "test-description-0",
      "l3_address_profile_id" : 0
    }, {
      "id" : 438086664193,
      "shared_secret" : "fnEbfBwhbh",
      "description" : "test-description-1",
      "l3_address_profile_id" : 1
    } ]
  }, {
    "id" : 5,
    "create_time" : "2024-04-03T19:55:26.000+0000",
    "update_time" : "2024-04-03T19:55:26.000+0000",
    "org_id" : 10,
    "name" : "internal_radius_server4",
    "description" : "test list",
    "authentication_method_group" : "LEAP",
    "default_authentication_method" : "LEAP",
    "enable_verify_server_cert" : true,
    "server_key_password" : "BKxtQ7O7WV",
    "enable_check_cert_common_name" : true,
    "enable_check_user_for_tls_auth" : true,
    "enable_check_user_for_peap_auth" : true,
    "enable_check_user_for_ttls_auth" : true,
    "enable_authentication_server" : true,
    "enable_radius_accounting_settings" : true,
    "authentication_server_port" : 1812,
    "active_session_limit" : 0,
    "active_session_age_timeout" : 60,
    "external_user_directory" : {
      "ldap_retry_interval" : 600,
      "local_check_interval" : 300,
      "remote_check_interval" : 30,
      "enable_radius_server_credential_caching" : true,
      "cache_lifetime" : 86400,
      "user_group_attribute" : "radiusGroupName",
      "external_user_directory_type" : "ACTIVE_DIRECTORY",
      "entries" : [ {
        "default_server_id" : 1,
        "server_role" : "PRIMARY"
      } ]
    },
    "ca_certificate_id" : 2,
    "server_certificate_id" : 3,
    "server_key_id" : 4,
    "device_ids" : [ 1, 2, 3 ],
    "clients" : [ {
      "id" : 438086664192,
      "shared_secret" : "zxYREWVmaB",
      "description" : "test-description-0",
      "l3_address_profile_id" : 0
    }, {
      "id" : 438086664193,
      "shared_secret" : "sFNOIYdILi",
      "description" : "test-description-1",
      "l3_address_profile_id" : 1
    } ]
  }, {
    "id" : 6,
    "create_time" : "2024-04-03T19:55:26.000+0000",
    "update_time" : "2024-04-03T19:55:26.000+0000",
    "org_id" : 10,
    "name" : "internal_radius_server5",
    "description" : "test list",
    "authentication_method_group" : "LEAP",
    "default_authentication_method" : "LEAP",
    "enable_verify_server_cert" : true,
    "server_key_password" : "BKxtQ7O7WV",
    "enable_check_cert_common_name" : true,
    "enable_check_user_for_tls_auth" : true,
    "enable_check_user_for_peap_auth" : true,
    "enable_check_user_for_ttls_auth" : true,
    "enable_authentication_server" : true,
    "enable_radius_accounting_settings" : true,
    "authentication_server_port" : 1812,
    "active_session_limit" : 0,
    "active_session_age_timeout" : 60,
    "external_user_directory" : {
      "ldap_retry_interval" : 600,
      "local_check_interval" : 300,
      "remote_check_interval" : 30,
      "enable_radius_server_credential_caching" : true,
      "cache_lifetime" : 86400,
      "user_group_attribute" : "radiusGroupName",
      "external_user_directory_type" : "ACTIVE_DIRECTORY",
      "entries" : [ {
        "default_server_id" : 1,
        "server_role" : "PRIMARY"
      } ]
    },
    "ca_certificate_id" : 2,
    "server_certificate_id" : 3,
    "server_key_id" : 4,
    "device_ids" : [ 1, 2, 3 ],
    "clients" : [ {
      "id" : 438086664192,
      "shared_secret" : "gQlwrjPepO",
      "description" : "test-description-0",
      "l3_address_profile_id" : 0
    }, {
      "id" : 438086664193,
      "shared_secret" : "UkozBEavXs",
      "description" : "test-description-1",
      "l3_address_profile_id" : 1
    } ]
  }, {
    "id" : 7,
    "create_time" : "2024-04-03T19:55:26.000+0000",
    "update_time" : "2024-04-03T19:55:26.000+0000",
    "org_id" : 10,
    "name" : "internal_radius_server6",
    "description" : "test list",
    "authentication_method_group" : "LEAP",
    "default_authentication_method" : "LEAP",
    "enable_verify_server_cert" : true,
    "server_key_password" : "BKxtQ7O7WV",
    "enable_check_cert_common_name" : true,
    "enable_check_user_for_tls_auth" : true,
    "enable_check_user_for_peap_auth" : true,
    "enable_check_user_for_ttls_auth" : true,
    "enable_authentication_server" : true,
    "enable_radius_accounting_settings" : true,
    "authentication_server_port" : 1812,
    "active_session_limit" : 0,
    "active_session_age_timeout" : 60,
    "external_user_directory" : {
      "ldap_retry_interval" : 600,
      "local_check_interval" : 300,
      "remote_check_interval" : 30,
      "enable_radius_server_credential_caching" : true,
      "cache_lifetime" : 86400,
      "user_group_attribute" : "radiusGroupName",
      "external_user_directory_type" : "ACTIVE_DIRECTORY",
      "entries" : [ {
        "default_server_id" : 1,
        "server_role" : "PRIMARY"
      } ]
    },
    "ca_certificate_id" : 2,
    "server_certificate_id" : 3,
    "server_key_id" : 4,
    "device_ids" : [ 1, 2, 3 ],
    "clients" : [ {
      "id" : 438086664192,
      "shared_secret" : "tfvWIzNlgR",
      "description" : "test-description-0",
      "l3_address_profile_id" : 0
    }, {
      "id" : 438086664193,
      "shared_secret" : "eunEJXzvNX",
      "description" : "test-description-1",
      "l3_address_profile_id" : 1
    } ]
  }, {
    "id" : 8,
    "create_time" : "2024-04-03T19:55:26.000+0000",
    "update_time" : "2024-04-03T19:55:26.000+0000",
    "org_id" : 10,
    "name" : "internal_radius_server7",
    "description" : "test list",
    "authentication_method_group" : "LEAP",
    "default_authentication_method" : "LEAP",
    "enable_verify_server_cert" : true,
    "server_key_password" : "BKxtQ7O7WV",
    "enable_check_cert_common_name" : true,
    "enable_check_user_for_tls_auth" : true,
    "enable_check_user_for_peap_auth" : true,
    "enable_check_user_for_ttls_auth" : true,
    "enable_authentication_server" : true,
    "enable_radius_accounting_settings" : true,
    "authentication_server_port" : 1812,
    "active_session_limit" : 0,
    "active_session_age_timeout" : 60,
    "external_user_directory" : {
      "ldap_retry_interval" : 600,
      "local_check_interval" : 300,
      "remote_check_interval" : 30,
      "enable_radius_server_credential_caching" : true,
      "cache_lifetime" : 86400,
      "user_group_attribute" : "radiusGroupName",
      "external_user_directory_type" : "ACTIVE_DIRECTORY",
      "entries" : [ {
        "default_server_id" : 1,
        "server_role" : "PRIMARY"
      } ]
    },
    "ca_certificate_id" : 2,
    "server_certificate_id" : 3,
    "server_key_id" : 4,
    "device_ids" : [ 1, 2, 3 ],
    "clients" : [ {
      "id" : 438086664192,
      "shared_secret" : "PPQagQEbNc",
      "description" : "test-description-0",
      "l3_address_profile_id" : 0
    }, {
      "id" : 438086664193,
      "shared_secret" : "TOMslMPemN",
      "description" : "test-description-1",
      "l3_address_profile_id" : 1
    } ]
  }, {
    "id" : 9,
    "create_time" : "2024-04-03T19:55:26.000+0000",
    "update_time" : "2024-04-03T19:55:26.000+0000",
    "org_id" : 10,
    "name" : "internal_radius_server8",
    "description" : "test list",
    "authentication_method_group" : "LEAP",
    "default_authentication_method" : "LEAP",
    "enable_verify_server_cert" : true,
    "server_key_password" : "BKxtQ7O7WV",
    "enable_check_cert_common_name" : true,
    "enable_check_user_for_tls_auth" : true,
    "enable_check_user_for_peap_auth" : true,
    "enable_check_user_for_ttls_auth" : true,
    "enable_authentication_server" : true,
    "enable_radius_accounting_settings" : true,
    "authentication_server_port" : 1812,
    "active_session_limit" : 0,
    "active_session_age_timeout" : 60,
    "external_user_directory" : {
      "ldap_retry_interval" : 600,
      "local_check_interval" : 300,
      "remote_check_interval" : 30,
      "enable_radius_server_credential_caching" : true,
      "cache_lifetime" : 86400,
      "user_group_attribute" : "radiusGroupName",
      "external_user_directory_type" : "ACTIVE_DIRECTORY",
      "entries" : [ {
        "default_server_id" : 1,
        "server_role" : "PRIMARY"
      } ]
    },
    "ca_certificate_id" : 2,
    "server_certificate_id" : 3,
    "server_key_id" : 4,
    "device_ids" : [ 1, 2, 3 ],
    "clients" : [ {
      "id" : 438086664192,
      "shared_secret" : "vqZsauYITf",
      "description" : "test-description-0",
      "l3_address_profile_id" : 0
    }, {
      "id" : 438086664193,
      "shared_secret" : "uzoBEgaZmo",
      "description" : "test-description-1",
      "l3_address_profile_id" : 1
    } ]
  }, {
    "id" : 10,
    "create_time" : "2024-04-03T19:55:26.000+0000",
    "update_time" : "2024-04-03T19:55:26.000+0000",
    "org_id" : 10,
    "name" : "internal_radius_server9",
    "description" : "test list",
    "authentication_method_group" : "LEAP",
    "default_authentication_method" : "LEAP",
    "enable_verify_server_cert" : true,
    "server_key_password" : "BKxtQ7O7WV",
    "enable_check_cert_common_name" : true,
    "enable_check_user_for_tls_auth" : true,
    "enable_check_user_for_peap_auth" : true,
    "enable_check_user_for_ttls_auth" : true,
    "enable_authentication_server" : true,
    "enable_radius_accounting_settings" : true,
    "authentication_server_port" : 1812,
    "active_session_limit" : 0,
    "active_session_age_timeout" : 60,
    "external_user_directory" : {
      "ldap_retry_interval" : 600,
      "local_check_interval" : 300,
      "remote_check_interval" : 30,
      "enable_radius_server_credential_caching" : true,
      "cache_lifetime" : 86400,
      "user_group_attribute" : "radiusGroupName",
      "external_user_directory_type" : "ACTIVE_DIRECTORY",
      "entries" : [ {
        "default_server_id" : 1,
        "server_role" : "PRIMARY"
      } ]
    },
    "ca_certificate_id" : 2,
    "server_certificate_id" : 3,
    "server_key_id" : 4,
    "device_ids" : [ 1, 2, 3 ],
    "clients" : [ {
      "id" : 438086664192,
      "shared_secret" : "aKLZeqDwPc",
      "description" : "test-description-0",
      "l3_address_profile_id" : 0
    }, {
      "id" : 438086664193,
      "shared_secret" : "hzukrNZYoj",
      "description" : "test-description-1",
      "l3_address_profile_id" : 1
    } ]
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/radius-servers/internal?page=1&limit=10' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNiwiZXhwIjoxNzEyNzc4OTI2fQ.XlCubs47IZDajOrRrv0U0cEw4Qwxm93r_FYT1R99qqY' \
    -H 'Content-Type: application/json'

List internal RADIUS devices

GET /radius-servers/internal/devices

Request Parameters

Parameter Description

page

Page number

limit

Page size

HTTP Request

GET /radius-servers/internal/devices?page=1&limit=10 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNywiZXhwIjoxNzEyNzc4OTI3fQ.1ru2kSXseyxpWNEvOZngpAFGqi6HMnPa7HBwjiS4cH8
Host: api.extremecloudiq.com
Content-Type: application/json

Response Fields

Path Type Description

page

Number

The current page number.

count

Number

The element count of the current page.

total_pages

Number

The total page number based on request page size.

total_count

Number

The total element count.

data[].id

Number

The inter RADIUS device ID used in RADIUS client object

data[].create_time

String

The create time.

data[].update_time

String

The last update time.

data[].org_id

Number

The organization identifier, valid when enabling HIQ feature.

data[].radius_server_id

Number

The internal RADIUS server id

data[].radius_server_name

String

The internal RADIUS server name

data[].host_name

String

The hostname of the RADIUS device

HTTP Response

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

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 2,
  "total_count" : 15,
  "data" : [ {
    "id" : 1,
    "create_time" : "2024-04-03T19:55:27.000+0000",
    "update_time" : "2024-04-03T19:55:27.000+0000",
    "org_id" : 10,
    "radius_server_id" : 100,
    "radius_server_name" : "test RADIUS name",
    "host_name" : "TEST ID"
  }, {
    "id" : 2,
    "create_time" : "2024-04-03T19:55:27.000+0000",
    "update_time" : "2024-04-03T19:55:27.000+0000",
    "org_id" : 10,
    "radius_server_id" : 100,
    "radius_server_name" : "test RADIUS name",
    "host_name" : "TEST ID"
  }, {
    "id" : 3,
    "create_time" : "2024-04-03T19:55:27.000+0000",
    "update_time" : "2024-04-03T19:55:27.000+0000",
    "org_id" : 10,
    "radius_server_id" : 100,
    "radius_server_name" : "test RADIUS name",
    "host_name" : "TEST ID"
  }, {
    "id" : 4,
    "create_time" : "2024-04-03T19:55:27.000+0000",
    "update_time" : "2024-04-03T19:55:27.000+0000",
    "org_id" : 10,
    "radius_server_id" : 100,
    "radius_server_name" : "test RADIUS name",
    "host_name" : "TEST ID"
  }, {
    "id" : 5,
    "create_time" : "2024-04-03T19:55:27.000+0000",
    "update_time" : "2024-04-03T19:55:27.000+0000",
    "org_id" : 10,
    "radius_server_id" : 100,
    "radius_server_name" : "test RADIUS name",
    "host_name" : "TEST ID"
  }, {
    "id" : 6,
    "create_time" : "2024-04-03T19:55:27.000+0000",
    "update_time" : "2024-04-03T19:55:27.000+0000",
    "org_id" : 10,
    "radius_server_id" : 100,
    "radius_server_name" : "test RADIUS name",
    "host_name" : "TEST ID"
  }, {
    "id" : 7,
    "create_time" : "2024-04-03T19:55:27.000+0000",
    "update_time" : "2024-04-03T19:55:27.000+0000",
    "org_id" : 10,
    "radius_server_id" : 100,
    "radius_server_name" : "test RADIUS name",
    "host_name" : "TEST ID"
  }, {
    "id" : 8,
    "create_time" : "2024-04-03T19:55:27.000+0000",
    "update_time" : "2024-04-03T19:55:27.000+0000",
    "org_id" : 10,
    "radius_server_id" : 100,
    "radius_server_name" : "test RADIUS name",
    "host_name" : "TEST ID"
  }, {
    "id" : 9,
    "create_time" : "2024-04-03T19:55:27.000+0000",
    "update_time" : "2024-04-03T19:55:27.000+0000",
    "org_id" : 10,
    "radius_server_id" : 100,
    "radius_server_name" : "test RADIUS name",
    "host_name" : "TEST ID"
  }, {
    "id" : 10,
    "create_time" : "2024-04-03T19:55:27.000+0000",
    "update_time" : "2024-04-03T19:55:27.000+0000",
    "org_id" : 10,
    "radius_server_id" : 100,
    "radius_server_name" : "test RADIUS name",
    "host_name" : "TEST ID"
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/radius-servers/internal/devices?page=1&limit=10' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNywiZXhwIjoxNzEyNzc4OTI3fQ.1ru2kSXseyxpWNEvOZngpAFGqi6HMnPa7HBwjiS4cH8' \
    -H 'Content-Type: application/json'

Create internal RADIUS server

POST /radius-servers/internal

Request Fields

Path Type Description

name

String

The internal RADIUS server configuration name

description

String

The internal RADIUS server configuration description

authentication_method_group

String

default_authentication_method

String

The default authentication method, CO_AUTHENTICATION_METHOD_TLS CO_AUTHENTICATION_METHOD_PEAP CO_AUTHENTICATION_METHOD_TTLS CO_AUTHENTICATION_METHOD_LEAP CO_AUTHENTICATION_METHOD_MD5

enable_verify_server_cert

Boolean

Enable verify server cert or not

server_key_password

String

password for server key

enable_check_cert_common_name

Boolean

Enable check cert common name or not.

enable_check_user_for_tls_auth

Boolean

Enable check user for TLS auth or not

enable_check_user_for_peap_auth

Boolean

Enable check user for PEAP auth or not,for Active Directory as the external user directory only

enable_check_user_for_ttls_auth

Boolean

Enable check user for TLS auth or not,for Active Directory as the external user directory only

enable_authentication_server

Boolean

Enable the RADIUS server as authentication or not

enable_radius_accounting_settings

Boolean

Enable the RADIUS server as accounting or not, must enable authentication server if want to enable accounting settings

authentication_server_port

Number

Port for the authentication, must enable authentication. Max:65535, Min:1

active_session_limit

Number

Active session limit, must enable accounting setting. Max:15, Min:0

active_session_age_timeout

Number

Active session age timeout in seconds, must enable accounting setting. Max:300000000, Min:0

ca_certificate_id

Number

The CA certificate ID

server_certificate_id

Number

The Server certificate ID

server_key_id

Number

The Server key ID

device_ids

Array

The list of device ID associated with the internal RADIUS server

clients[].id

Number

The associate RADIUS client ID

clients[].description

String

The description for associate RADIUS client

clients[].shared_secret

String

The shared secret for associate RADIUS client

clients[].l3_address_profile_id

Number

The L3 address profile ID for associate RADIUS client

external_user_directory.ldap_retry_interval

Number

Retry the previously unresponsive primary server after the specified seconds

external_user_directory.local_check_interval

Number

Time to user local cache if none of the external servers are reachable in seconds

external_user_directory.remote_check_interval

Number

Try the next backup server after specified seconds

external_user_directory.enable_radius_server_credential_caching

Boolean

Caching credentials allows for better performance and higher availability by reducing the dependence on RADIUS servers across high-latency WAN links.

external_user_directory.cache_lifetime

Number

Retain Cache for specified seconds

external_user_directory.user_group_attribute

String

The user group attribute

external_user_directory.external_user_directory_type

String

CO_EXTERNAL_USER_DIRECTORY_TYPE_OPEN_LDAP or CO_EXTERNAL_USER_DIRECTORY_TYPE_ACTIVE_DIRECTORY

external_user_directory.entries[].default_server_id

Number

The default external user directory server id

external_user_directory.entries[].server_role

String

The server role, Primary or Backup

HTTP Request

POST /radius-servers/internal HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNywiZXhwIjoxNzEyNzc4OTI3fQ.1ru2kSXseyxpWNEvOZngpAFGqi6HMnPa7HBwjiS4cH8
Host: api.extremecloudiq.com
Content-Length: 1252
Content-Type: application/json

{
  "name" : "internal_radius_server",
  "description" : "test create",
  "authentication_method_group" : "LEAP",
  "default_authentication_method" : "LEAP",
  "enable_verify_server_cert" : true,
  "server_key_password" : "BKxtQ7O7WV",
  "enable_check_cert_common_name" : true,
  "enable_check_user_for_tls_auth" : true,
  "enable_check_user_for_peap_auth" : true,
  "enable_check_user_for_ttls_auth" : true,
  "enable_authentication_server" : true,
  "enable_radius_accounting_settings" : true,
  "authentication_server_port" : 1812,
  "active_session_limit" : 0,
  "active_session_age_timeout" : 60,
  "external_user_directory" : {
    "ldap_retry_interval" : 600,
    "local_check_interval" : 300,
    "remote_check_interval" : 30,
    "enable_radius_server_credential_caching" : true,
    "cache_lifetime" : 86400,
    "user_group_attribute" : "radiusGroupName",
    "external_user_directory_type" : "ACTIVE_DIRECTORY",
    "entries" : [ {
      "default_server_id" : 1,
      "server_role" : "PRIMARY"
    } ]
  },
  "ca_certificate_id" : 2,
  "server_certificate_id" : 3,
  "server_key_id" : 4,
  "device_ids" : [ 5, 6, 7 ],
  "clients" : [ {
    "shared_secret" : "BKxtQ7O7WV",
    "description" : "test",
    "l3_address_profile_id" : 2
  } ]
}

Response Fields

Path Type Description

id

Number

The internal RADIUS server ID.

create_time

String

The create time.

update_time

String

The last update time.

org_id

Number

The organization identifier, valid when enabling HIQ feature.

name

String

The internal RADIUS server configuration name

description

String

The internal RADIUS server configuration description

authentication_method_group

String

default_authentication_method

String

The default authentication method, CO_AUTHENTICATION_METHOD_TLS CO_AUTHENTICATION_METHOD_PEAP CO_AUTHENTICATION_METHOD_TTLS CO_AUTHENTICATION_METHOD_LEAP CO_AUTHENTICATION_METHOD_MD5

enable_verify_server_cert

Boolean

Enable verify server cert or not

server_key_password

String

password for server key

enable_check_cert_common_name

Boolean

Enable check cert common name or not.

enable_check_user_for_tls_auth

Boolean

Enable check user for TLS auth or not

enable_check_user_for_peap_auth

Boolean

Enable check user for PEAP auth or not,for Active Directory as the external user directory only

enable_check_user_for_ttls_auth

Boolean

Enable check user for TLS auth or not,for Active Directory as the external user directory only

enable_authentication_server

Boolean

Enable the RADIUS server as authentication or not

enable_radius_accounting_settings

Boolean

Enable the RADIUS server as accounting or not, must enable authentication server if want to enable accounting settings

authentication_server_port

Number

Port for the authentication, must enable authentication. Max:65535, Min:1

active_session_limit

Number

Active session limit, must enable accounting setting. Max:15, Min:0

active_session_age_timeout

Number

Active session age timeout in seconds, must enable accounting setting. Max:300000000, Min:0

ca_certificate_id

Number

The CA certificate ID

server_certificate_id

Number

The Server certificate ID

server_key_id

Number

The Server key ID

device_ids

Array

The list of device ID associated with the internal RADIUS server

clients[].id

Number

The associate RADIUS client ID

clients[].description

String

The description for associate RADIUS client

clients[].shared_secret

String

The shared secret for associate RADIUS client

clients[].l3_address_profile_id

Number

The L3 address profile ID for associate RADIUS client

external_user_directory.ldap_retry_interval

Number

Retry the previously unresponsive primary server after the specified seconds

external_user_directory.local_check_interval

Number

Time to user local cache if none of the external servers are reachable in seconds

external_user_directory.remote_check_interval

Number

Try the next backup server after specified seconds

external_user_directory.enable_radius_server_credential_caching

Boolean

Caching credentials allows for better performance and higher availability by reducing the dependence on RADIUS servers across high-latency WAN links.

external_user_directory.cache_lifetime

Number

Retain Cache for specified seconds

external_user_directory.user_group_attribute

String

The user group attribute

external_user_directory.external_user_directory_type

String

CO_EXTERNAL_USER_DIRECTORY_TYPE_OPEN_LDAP or CO_EXTERNAL_USER_DIRECTORY_TYPE_ACTIVE_DIRECTORY

external_user_directory.entries[].default_server_id

Number

The default external user directory server id

external_user_directory.entries[].server_role

String

The server role, Primary or Backup

HTTP Response

HTTP/1.1 201 Created
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
Content-Length: 1560
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

{
  "id" : 1,
  "create_time" : "2024-04-03T19:55:27.000+0000",
  "update_time" : "2024-04-03T19:55:27.000+0000",
  "org_id" : 10,
  "name" : "internal_radius_server",
  "description" : "test list",
  "authentication_method_group" : "LEAP",
  "default_authentication_method" : "LEAP",
  "enable_verify_server_cert" : true,
  "server_key_password" : "BKxtQ7O7WV",
  "enable_check_cert_common_name" : true,
  "enable_check_user_for_tls_auth" : true,
  "enable_check_user_for_peap_auth" : true,
  "enable_check_user_for_ttls_auth" : true,
  "enable_authentication_server" : true,
  "enable_radius_accounting_settings" : true,
  "authentication_server_port" : 1812,
  "active_session_limit" : 0,
  "active_session_age_timeout" : 60,
  "external_user_directory" : {
    "ldap_retry_interval" : 600,
    "local_check_interval" : 300,
    "remote_check_interval" : 30,
    "enable_radius_server_credential_caching" : true,
    "cache_lifetime" : 86400,
    "user_group_attribute" : "radiusGroupName",
    "external_user_directory_type" : "ACTIVE_DIRECTORY",
    "entries" : [ {
      "default_server_id" : 1,
      "server_role" : "PRIMARY"
    } ]
  },
  "ca_certificate_id" : 2,
  "server_certificate_id" : 3,
  "server_key_id" : 4,
  "device_ids" : [ 1, 2, 3 ],
  "clients" : [ {
    "id" : 438086664192,
    "shared_secret" : "RxfjoKZWQB",
    "description" : "test-description-0",
    "l3_address_profile_id" : 0
  }, {
    "id" : 438086664193,
    "shared_secret" : "iywbsddECA",
    "description" : "test-description-1",
    "l3_address_profile_id" : 1
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/radius-servers/internal' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNywiZXhwIjoxNzEyNzc4OTI3fQ.1ru2kSXseyxpWNEvOZngpAFGqi6HMnPa7HBwjiS4cH8' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "internal_radius_server",
  "description" : "test create",
  "authentication_method_group" : "LEAP",
  "default_authentication_method" : "LEAP",
  "enable_verify_server_cert" : true,
  "server_key_password" : "BKxtQ7O7WV",
  "enable_check_cert_common_name" : true,
  "enable_check_user_for_tls_auth" : true,
  "enable_check_user_for_peap_auth" : true,
  "enable_check_user_for_ttls_auth" : true,
  "enable_authentication_server" : true,
  "enable_radius_accounting_settings" : true,
  "authentication_server_port" : 1812,
  "active_session_limit" : 0,
  "active_session_age_timeout" : 60,
  "external_user_directory" : {
    "ldap_retry_interval" : 600,
    "local_check_interval" : 300,
    "remote_check_interval" : 30,
    "enable_radius_server_credential_caching" : true,
    "cache_lifetime" : 86400,
    "user_group_attribute" : "radiusGroupName",
    "external_user_directory_type" : "ACTIVE_DIRECTORY",
    "entries" : [ {
      "default_server_id" : 1,
      "server_role" : "PRIMARY"
    } ]
  },
  "ca_certificate_id" : 2,
  "server_certificate_id" : 3,
  "server_key_id" : 4,
  "device_ids" : [ 5, 6, 7 ],
  "clients" : [ {
    "shared_secret" : "BKxtQ7O7WV",
    "description" : "test",
    "l3_address_profile_id" : 2
  } ]
}'

List internal RADIUS server

GET /radius-servers/internal/{id}

Path Parameters

Table 132. /radius-servers/internal/{id}
Parameter	Description
`id`	The internal RADIUS server ID

HTTP Request

GET /radius-servers/internal/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNywiZXhwIjoxNzEyNzc4OTI3fQ.1ru2kSXseyxpWNEvOZngpAFGqi6HMnPa7HBwjiS4cH8
Host: api.extremecloudiq.com
Content-Type: application/json

Response Fields

Path Type Description

id

Number

The internal RADIUS server ID.

create_time

String

The create time.

update_time

String

The last update time.

org_id

Number

The organization identifier, valid when enabling HIQ feature.

name

String

The internal RADIUS server configuration name

description

String

The internal RADIUS server configuration description

authentication_method_group

String

default_authentication_method

String

The default authentication method, CO_AUTHENTICATION_METHOD_TLS CO_AUTHENTICATION_METHOD_PEAP CO_AUTHENTICATION_METHOD_TTLS CO_AUTHENTICATION_METHOD_LEAP CO_AUTHENTICATION_METHOD_MD5

enable_verify_server_cert

Boolean

Enable verify server cert or not

server_key_password

String

password for server key

enable_check_cert_common_name

Boolean

Enable check cert common name or not.

enable_check_user_for_tls_auth

Boolean

Enable check user for TLS auth or not

enable_check_user_for_peap_auth

Boolean

Enable check user for PEAP auth or not,for Active Directory as the external user directory only

enable_check_user_for_ttls_auth

Boolean

Enable check user for TLS auth or not,for Active Directory as the external user directory only

enable_authentication_server

Boolean

Enable the RADIUS server as authentication or not

enable_radius_accounting_settings

Boolean

Enable the RADIUS server as accounting or not, must enable authentication server if want to enable accounting settings

authentication_server_port

Number

Port for the authentication, must enable authentication. Max:65535, Min:1

active_session_limit

Number

Active session limit, must enable accounting setting. Max:15, Min:0

active_session_age_timeout

Number

Active session age timeout in seconds, must enable accounting setting. Max:300000000, Min:0

ca_certificate_id

Number

The CA certificate ID

server_certificate_id

Number

The Server certificate ID

server_key_id

Number

The Server key ID

device_ids

Array

The list of device ID associated with the internal RADIUS server

clients[].id

Number

The associate RADIUS client ID

clients[].description

String

The description for associate RADIUS client

clients[].shared_secret

String

The shared secret for associate RADIUS client

clients[].l3_address_profile_id

Number

The L3 address profile ID for associate RADIUS client

external_user_directory.ldap_retry_interval

Number

Retry the previously unresponsive primary server after the specified seconds

external_user_directory.local_check_interval

Number

Time to user local cache if none of the external servers are reachable in seconds

external_user_directory.remote_check_interval

Number

Try the next backup server after specified seconds

external_user_directory.enable_radius_server_credential_caching

Boolean

Caching credentials allows for better performance and higher availability by reducing the dependence on RADIUS servers across high-latency WAN links.

external_user_directory.cache_lifetime

Number

Retain Cache for specified seconds

external_user_directory.user_group_attribute

String

The user group attribute

external_user_directory.external_user_directory_type

String

CO_EXTERNAL_USER_DIRECTORY_TYPE_OPEN_LDAP or CO_EXTERNAL_USER_DIRECTORY_TYPE_ACTIVE_DIRECTORY

external_user_directory.entries[].default_server_id

Number

The default external user directory server id

external_user_directory.entries[].server_role

String

The server role, Primary or Backup

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: 1560
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

{
  "id" : 1,
  "create_time" : "2024-04-03T19:55:27.000+0000",
  "update_time" : "2024-04-03T19:55:27.000+0000",
  "org_id" : 10,
  "name" : "internal_radius_server",
  "description" : "test list",
  "authentication_method_group" : "LEAP",
  "default_authentication_method" : "LEAP",
  "enable_verify_server_cert" : true,
  "server_key_password" : "BKxtQ7O7WV",
  "enable_check_cert_common_name" : true,
  "enable_check_user_for_tls_auth" : true,
  "enable_check_user_for_peap_auth" : true,
  "enable_check_user_for_ttls_auth" : true,
  "enable_authentication_server" : true,
  "enable_radius_accounting_settings" : true,
  "authentication_server_port" : 1812,
  "active_session_limit" : 0,
  "active_session_age_timeout" : 60,
  "external_user_directory" : {
    "ldap_retry_interval" : 600,
    "local_check_interval" : 300,
    "remote_check_interval" : 30,
    "enable_radius_server_credential_caching" : true,
    "cache_lifetime" : 86400,
    "user_group_attribute" : "radiusGroupName",
    "external_user_directory_type" : "ACTIVE_DIRECTORY",
    "entries" : [ {
      "default_server_id" : 1,
      "server_role" : "PRIMARY"
    } ]
  },
  "ca_certificate_id" : 2,
  "server_certificate_id" : 3,
  "server_key_id" : 4,
  "device_ids" : [ 1, 2, 3 ],
  "clients" : [ {
    "id" : 438086664192,
    "shared_secret" : "rMJevhWqlt",
    "description" : "test-description-0",
    "l3_address_profile_id" : 0
  }, {
    "id" : 438086664193,
    "shared_secret" : "UvJmQravnQ",
    "description" : "test-description-1",
    "l3_address_profile_id" : 1
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/radius-servers/internal/438086664193' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNywiZXhwIjoxNzEyNzc4OTI3fQ.1ru2kSXseyxpWNEvOZngpAFGqi6HMnPa7HBwjiS4cH8' \
    -H 'Content-Type: application/json'

Update internal RADIUS server

PUT /radius-servers/internal/{id}

Path Parameters

Table 133. /radius-servers/internal/{id}
Parameter	Description
`id`	The external RADIUS server configuration ID

Request Fields

Path Type Description

name

String

The internal RADIUS server configuration name

description

String

The internal RADIUS server configuration description

authentication_method_group

String

default_authentication_method

String

The default authentication method, CO_AUTHENTICATION_METHOD_TLS CO_AUTHENTICATION_METHOD_PEAP CO_AUTHENTICATION_METHOD_TTLS CO_AUTHENTICATION_METHOD_LEAP CO_AUTHENTICATION_METHOD_MD5

enable_verify_server_cert

Boolean

Enable verify server cert or not

server_key_password

String

password for server key

enable_check_cert_common_name

Boolean

Enable check cert common name or not.

enable_check_user_for_tls_auth

Boolean

Enable check user for TLS auth or not

enable_check_user_for_peap_auth

Boolean

Enable check user for PEAP auth or not,for Active Directory as the external user directory only

enable_check_user_for_ttls_auth

Boolean

Enable check user for TLS auth or not,for Active Directory as the external user directory only

enable_authentication_server

Boolean

Enable the RADIUS server as authentication or not

enable_radius_accounting_settings

Boolean

Enable the RADIUS server as accounting or not, must enable authentication server if want to enable accounting settings

authentication_server_port

Number

Port for the authentication, must enable authentication. Max:65535, Min:1

active_session_limit

Number

Active session limit, must enable accounting setting. Max:15, Min:0

active_session_age_timeout

Number

Active session age timeout in seconds, must enable accounting setting. Max:300000000, Min:0

ca_certificate_id

Number

The CA certificate ID

server_certificate_id

Number

The Server certificate ID

server_key_id

Number

The Server key ID

clients[].id

Number

The associate RADIUS client ID

clients[].description

String

The description for associate RADIUS client

clients[].shared_secret

String

The shared secret for associate RADIUS client

clients[].l3_address_profile_id

Number

The L3 address profile ID for associate RADIUS client

HTTP Request

PUT /radius-servers/internal/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Content-Length: 804
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNiwiZXhwIjoxNzEyNzc4OTI2fQ.XlCubs47IZDajOrRrv0U0cEw4Qwxm93r_FYT1R99qqY
Content-Type: application/json

{
  "name" : "internal_radius_server",
  "description" : "test create",
  "authentication_method_group" : "LEAP",
  "default_authentication_method" : "LEAP",
  "enable_verify_server_cert" : true,
  "server_key_password" : "BKxtQ7O7WV",
  "enable_check_cert_common_name" : true,
  "enable_check_user_for_tls_auth" : true,
  "enable_check_user_for_peap_auth" : true,
  "enable_check_user_for_ttls_auth" : true,
  "enable_authentication_server" : true,
  "enable_radius_accounting_settings" : true,
  "authentication_server_port" : 1812,
  "active_session_limit" : 0,
  "active_session_age_timeout" : 60,
  "ca_certificate_id" : 2,
  "server_certificate_id" : 3,
  "server_key_id" : 4,
  "clients" : [ {
    "shared_secret" : "BKxtQ7O7WV",
    "description" : "test",
    "l3_address_profile_id" : 2
  } ]
}

Response Fields

Path Type Description

id

Number

The internal RADIUS server ID.

create_time

String

The create time.

update_time

String

The last update time.

org_id

Number

The organization identifier, valid when enabling HIQ feature.

name

String

The internal RADIUS server configuration name

description

String

The internal RADIUS server configuration description

authentication_method_group

String

default_authentication_method

String

The default authentication method, CO_AUTHENTICATION_METHOD_TLS CO_AUTHENTICATION_METHOD_PEAP CO_AUTHENTICATION_METHOD_TTLS CO_AUTHENTICATION_METHOD_LEAP CO_AUTHENTICATION_METHOD_MD5

enable_verify_server_cert

Boolean

Enable verify server cert or not

server_key_password

String

password for server key

enable_check_cert_common_name

Boolean

Enable check cert common name or not.

enable_check_user_for_tls_auth

Boolean

Enable check user for TLS auth or not

enable_check_user_for_peap_auth

Boolean

Enable check user for PEAP auth or not,for Active Directory as the external user directory only

enable_check_user_for_ttls_auth

Boolean

Enable check user for TLS auth or not,for Active Directory as the external user directory only

enable_authentication_server

Boolean

Enable the RADIUS server as authentication or not

enable_radius_accounting_settings

Boolean

Enable the RADIUS server as accounting or not, must enable authentication server if want to enable accounting settings

authentication_server_port

Number

Port for the authentication, must enable authentication. Max:65535, Min:1

active_session_limit

Number

Active session limit, must enable accounting setting. Max:15, Min:0

active_session_age_timeout

Number

Active session age timeout in seconds, must enable accounting setting. Max:300000000, Min:0

ca_certificate_id

Number

The CA certificate ID

server_certificate_id

Number

The Server certificate ID

server_key_id

Number

The Server key ID

device_ids

Array

The list of device ID associated with the internal RADIUS server

clients[].id

Number

The associate RADIUS client ID

clients[].description

String

The description for associate RADIUS client

clients[].shared_secret

String

The shared secret for associate RADIUS client

clients[].l3_address_profile_id

Number

The L3 address profile ID for associate RADIUS client

external_user_directory.ldap_retry_interval

Number

Retry the previously unresponsive primary server after the specified seconds

external_user_directory.local_check_interval

Number

Time to user local cache if none of the external servers are reachable in seconds

external_user_directory.remote_check_interval

Number

Try the next backup server after specified seconds

external_user_directory.enable_radius_server_credential_caching

Boolean

Caching credentials allows for better performance and higher availability by reducing the dependence on RADIUS servers across high-latency WAN links.

external_user_directory.cache_lifetime

Number

Retain Cache for specified seconds

external_user_directory.user_group_attribute

String

The user group attribute

external_user_directory.external_user_directory_type

String

CO_EXTERNAL_USER_DIRECTORY_TYPE_OPEN_LDAP or CO_EXTERNAL_USER_DIRECTORY_TYPE_ACTIVE_DIRECTORY

external_user_directory.entries[].default_server_id

Number

The default external user directory server id

external_user_directory.entries[].server_role

String

The server role, Primary or Backup

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

{
  "id" : 1,
  "create_time" : "2024-04-03T19:55:26.000+0000",
  "update_time" : "2024-04-03T19:55:26.000+0000",
  "org_id" : 10,
  "name" : "internal_radius_server",
  "description" : "test list",
  "authentication_method_group" : "LEAP",
  "default_authentication_method" : "LEAP",
  "enable_verify_server_cert" : true,
  "server_key_password" : "BKxtQ7O7WV",
  "enable_check_cert_common_name" : true,
  "enable_check_user_for_tls_auth" : true,
  "enable_check_user_for_peap_auth" : true,
  "enable_check_user_for_ttls_auth" : true,
  "enable_authentication_server" : true,
  "enable_radius_accounting_settings" : true,
  "authentication_server_port" : 1812,
  "active_session_limit" : 0,
  "active_session_age_timeout" : 60,
  "external_user_directory" : {
    "ldap_retry_interval" : 600,
    "local_check_interval" : 300,
    "remote_check_interval" : 30,
    "enable_radius_server_credential_caching" : true,
    "cache_lifetime" : 86400,
    "user_group_attribute" : "radiusGroupName",
    "external_user_directory_type" : "ACTIVE_DIRECTORY",
    "entries" : [ {
      "default_server_id" : 1,
      "server_role" : "PRIMARY"
    } ]
  },
  "ca_certificate_id" : 2,
  "server_certificate_id" : 3,
  "server_key_id" : 4,
  "device_ids" : [ 1, 2, 3 ],
  "clients" : [ {
    "id" : 438086664192,
    "shared_secret" : "NnmWdCisfm",
    "description" : "test-description-0",
    "l3_address_profile_id" : 0
  }, {
    "id" : 438086664193,
    "shared_secret" : "mWrLwWWmaj",
    "description" : "test-description-1",
    "l3_address_profile_id" : 1
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/radius-servers/internal/438086664193' -i -X PUT \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNiwiZXhwIjoxNzEyNzc4OTI2fQ.XlCubs47IZDajOrRrv0U0cEw4Qwxm93r_FYT1R99qqY' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "internal_radius_server",
  "description" : "test create",
  "authentication_method_group" : "LEAP",
  "default_authentication_method" : "LEAP",
  "enable_verify_server_cert" : true,
  "server_key_password" : "BKxtQ7O7WV",
  "enable_check_cert_common_name" : true,
  "enable_check_user_for_tls_auth" : true,
  "enable_check_user_for_peap_auth" : true,
  "enable_check_user_for_ttls_auth" : true,
  "enable_authentication_server" : true,
  "enable_radius_accounting_settings" : true,
  "authentication_server_port" : 1812,
  "active_session_limit" : 0,
  "active_session_age_timeout" : 60,
  "ca_certificate_id" : 2,
  "server_certificate_id" : 3,
  "server_key_id" : 4,
  "clients" : [ {
    "shared_secret" : "BKxtQ7O7WV",
    "description" : "test",
    "l3_address_profile_id" : 2
  } ]
}'

Delete internal RADIUS server

DELETE /radius-servers/internal/{id}

Path Parameters

Table 134. /radius-servers/internal/{id}
Parameter	Description
`id`	The internal RADIUS server configuration ID

HTTP Request

DELETE /radius-servers/internal/438086664193 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNywiZXhwIjoxNzEyNzc4OTI3fQ.1ru2kSXseyxpWNEvOZngpAFGqi6HMnPa7HBwjiS4cH8
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: 7404
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/radius-servers/internal/438086664193' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEyNywiZXhwIjoxNzEyNzc4OTI3fQ.1ru2kSXseyxpWNEvOZngpAFGqi6HMnPa7HBwjiS4cH8' \
    -H 'Content-Type: application/json'

Configuration - Certificate

List certificates

GET /certificates

Request Parameters

Parameter Description

page

Page number

limit

Page size

certType

The certificate type: CERT or KEY

HTTP Request

GET /certificates?certType=CERT HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEzMCwiZXhwIjoxNzEyNzc4OTMwfQ.tvh-FvYhhgcM61Oiz8d-_7zAMalahBdIahIJ__lB67k
Content-Type: application/json

Response Fields

Path Type Description

page

Number

The current page number.

count

Number

The element count of the current page.

total_pages

Number

The total page number based on request page size.

total_count

Number

The total element count.

data[].id

Number

The address profile ID.

data[].create_time

String

The timestamp when the location was created.

data[].update_time

String

The timestamp when the location was last updated.

data[].name

String

The name of the certificate file.

data[].cert_type

String

The certificate type: CERT or KEY

data[].encrypted

Boolean

The certificate is encrypted or not

data[].description

String

The certificate file description

data[].file_size

Number

The certificate file size

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Remaining: 7376
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

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 2,
  "total_count" : 15,
  "data" : [ {
    "id" : 1,
    "create_time" : "2024-04-03T19:55:30.000+0000",
    "update_time" : "2024-04-03T19:55:30.000+0000",
    "cert_type" : "CERT",
    "name" : "test_cert",
    "encrypted" : false,
    "description" : "Default server cert file",
    "file_size" : 875
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/certificates?certType=CERT' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEzMCwiZXhwIjoxNzEyNzc4OTMwfQ.tvh-FvYhhgcM61Oiz8d-_7zAMalahBdIahIJ__lB67k' \
    -H 'Content-Type: application/json'

Packet Capture

List packet captures

GET /packetcaptures

Request Parameters

Parameter Description

searchString

The search string

page

Page number

limit

Page size

sortField

Sort field

order

Sort order (ascending by default)

fields

The packet capture fields to return.
[All available fields]: id, org_id, name, capture_id_type, ap_serial_number, device_ids, location_id, duration, destination, filter, capture_if, start_time, end_time, status, cloud_storage, results

HTTP Request

GET /packetcaptures?searchString=Extreme HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEzMiwiZXhwIjoxNzEyNzc4OTMyfQ.1Rpjje_LO_ncIc-Y10G7-pDDTsPgM4IxjkSh1Pjyl0w
Content-Type: application/json

Response Fields

Path Type Description

page

Number

The current page number.

count

Number

The element count of the current page.

total_pages

Number

The total page number based on request page size.

total_count

Number

The total element count.

data[].id

Number

The packet capture ID.

data[].start_time

String

The packet capture start time

data[].end_time

String

The packet capture end time

data[].org_id

Number

The organization identifier, valid when enabling HIQ feature.

data[].name

String

The packet capture session name. If the name is null or empty, it will be auto generated.

data[].capture_id_type

String

The capture identifier type for selecting the APs. Depending on the type, one of "ap_serial_number", "device_ids" or "location_id" must be provided.

data[].ap_serial_number

String

The globally unique serial number of the device being registered. The serial number is represented as a string.

data[].device_ids

Array

The device ID list

data[].location_id

Number

The assigned location ID, it must be FLOOR type

data[].duration

Number

An integer containing the set packet capture duration in seconds, from 5 to a maximum of 604800 seconds (1 week). If duration is set to 0 or unspecified, capture stops when platform-maximum size is reached.

data[].destination

String

The destination for the packet capture files. CLOUD for XIQ cloud storage. CLOUD_SHARK for sending the capture files to CloudShark, in addition to XIQ cloud storage.

data[].filter

Object

This represents the properties of filters used for the packet capture.

data[].filter.mac_addr

Array

List of the client MAC addresses used for packet capturing

data[].filter.ip_addr

Array

List of the client IP addresses used to filter the packets

data[].filter.protocol

String

Protocol type to filter by

data[].filter.protocol_number

Number

The protocol number if protocol is "USER_DEFINED"

data[].filter.port

Number

The port for packet capture

data[].filter.vlan

String

Specific vlan ids in a string, e.g. range "2-100"; single "3"; list "1,2,5,7,122"; mixed "2,4,5-10,19,29". If not specified, default is all VLANs.

data[].filter.wlan

String

A WLAN SSID. If not specified, default is all WLANs.

data[].capture_if

Object

This represents the options for location packet capture.

data[].capture_if.direction

String

The capture traffic direction

data[].capture_if.radio

String

The wireless radio to capture. Set to ALL for all radios.

data[].capture_if.wireless_band

String

The wireless band to capture. Set to ALL for all bands.

data[].capture_if.wired_interface

String

The name of the wired interface to capture. Set to ALL for all interfaces.

data[].capture_if.wired_filters

Array

The list of pre-defined wired filters for packet capture

data[].capture_if.wireless_filters

Array

The list of pre-defined wireless filters for packet capture

data[].status

String

The status of the packet capture session

data[].cloud_storage

String

XIQ cloud storage location for the archive of all capture files in this capture session, if available.

data[].results

Array

The list of packet capture results - a PacketCaptureResult for each device’s interface

data[].results[].id

Number

The packet capture result ID

data[].results[].org_id

Number

The organization identifier, valid when enabling HIQ feature

data[].results[].device_id

Number

The device identifier

data[].results[].hostname

String

The device host name

data[].results[].interface_name

String

The interface name such as "WIFI0", "WIFI1", "ETH0", etc.

data[].results[].location_id

Number

The location ID

data[].results[].locations

Array

The detailed location

data[].results[].locations[].id

Number

The location ID

data[].results[].locations[].name

String

The location name

data[].results[].mac_address

String

The device MAC address

data[].results[].status

String

The status of the packet capture result

data[].results[].start_time

String

The packet capture start time

data[].results[].end_time

String

The packet capture end time

data[].results[].error_message

String

The error message (may be empty)

data[].results[].storage.cloud_storage

String

XIQ cloud storage location after a packet capture is completed

data[].results[].storage.cloud_shark_storage

Object

The packet capture file name and URL in CloudShark

data[].results[].storage.cloud_shark_storage.file_name

String

File name in CloudShark

data[].results[].storage.cloud_shark_storage.file_url

String

File URL in CloudShark

HTTP Response

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

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 2,
  "total_count" : 15,
  "data" : [ {
    "id" : 230000,
    "start_time" : "2023-08-11T21:40:00.000+0000",
    "end_time" : "2023-08-11T21:45:15.000+0000",
    "org_id" : 0,
    "name" : "capture name 0",
    "duration" : 300,
    "capture_id_type" : "DEVICE_IDS",
    "device_ids" : [ 123000, 123005 ],
    "destination" : "CLOUD",
    "filter" : {
      "mac_addr" : [ "AABBCC001122" ],
      "ip_addr" : [ "192.168.11.255" ],
      "protocol" : "USER_DEFINED",
      "protocol_number" : 5,
      "port" : 1024,
      "vlan" : "2,3-5",
      "wlan" : "some-ssid"
    },
    "capture_if" : {
      "direction" : "BOTH",
      "radio" : "ALL",
      "wired_interface" : "ETH0",
      "wireless_band" : "2.4GHZ",
      "wired_filters" : [ "DHCP" ],
      "wireless_filters" : [ "DATA", "CONTROL" ]
    },
    "status" : "SUCCESS",
    "results" : [ {
      "id" : 240000,
      "org_id" : 0,
      "start_time" : "2023-08-11T21:40:00.000+0000",
      "end_time" : "2023-08-11T21:45:00.000+0000",
      "device_id" : 123000,
      "hostname" : "host.name0",
      "mac_address" : "BCF310778640",
      "interface_name" : "WIFI0",
      "location_id" : 339506,
      "locations" : [ {
        "id" : 339506,
        "name" : "test-location"
      } ],
      "status" : "SUCCESS",
      "storage" : {
        "cloud_storage" : "123/627588202497/BCF310778640/627588202497-wifi0.pcap",
        "cloud_shark_storage" : {
          "file_name" : "20230809182410UTC-BCF310778640-wifi0.pcap",
          "file_url" : "https://www.cloudshark.org/captures/f27d14944000"
        }
      }
    }, {
      "id" : 240001,
      "org_id" : 0,
      "start_time" : "2023-08-11T21:40:00.000+0000",
      "end_time" : "2023-08-11T21:45:00.000+0000",
      "device_id" : 123005,
      "hostname" : "host.name1",
      "mac_address" : "BCF310778641",
      "interface_name" : "WIFI0",
      "location_id" : 339506,
      "locations" : [ {
        "id" : 339506,
        "name" : "test-location"
      } ],
      "status" : "SUCCESS",
      "storage" : {
        "cloud_storage" : "123/627588202497/BCF310778641/627588202497-wifi0.pcap",
        "cloud_shark_storage" : {
          "file_name" : "20230809182410UTC-BCF310778641-wifi0.pcap",
          "file_url" : "https://www.cloudshark.org/captures/f27d14944001"
        }
      }
    } ],
    "cloud_storage" : "123/archive/230000-pcap.tar"
  }, {
    "id" : 230001,
    "start_time" : "2023-08-11T21:40:00.000+0000",
    "end_time" : "2023-08-11T21:45:15.000+0000",
    "org_id" : 0,
    "name" : "capture name 1",
    "duration" : 300,
    "capture_id_type" : "DEVICE_IDS",
    "device_ids" : [ 123000, 123005 ],
    "destination" : "CLOUD",
    "filter" : {
      "mac_addr" : [ "AABBCC001122" ],
      "ip_addr" : [ "192.168.11.255" ],
      "protocol" : "USER_DEFINED",
      "protocol_number" : 5,
      "port" : 1024,
      "vlan" : "2,3-5",
      "wlan" : "some-ssid"
    },
    "capture_if" : {
      "direction" : "BOTH",
      "radio" : "ALL",
      "wired_interface" : "ETH0",
      "wireless_band" : "2.4GHZ",
      "wired_filters" : [ "DHCP" ],
      "wireless_filters" : [ "DATA", "CONTROL" ]
    },
    "status" : "SUCCESS",
    "results" : [ {
      "id" : 240000,
      "org_id" : 0,
      "start_time" : "2023-08-11T21:40:00.000+0000",
      "end_time" : "2023-08-11T21:45:00.000+0000",
      "device_id" : 123000,
      "hostname" : "host.name0",
      "mac_address" : "BCF310778640",
      "interface_name" : "WIFI0",
      "location_id" : 339506,
      "locations" : [ {
        "id" : 339506,
        "name" : "test-location"
      } ],
      "status" : "SUCCESS",
      "storage" : {
        "cloud_storage" : "123/627588202497/BCF310778640/627588202497-wifi0.pcap",
        "cloud_shark_storage" : {
          "file_name" : "20230809182410UTC-BCF310778640-wifi0.pcap",
          "file_url" : "https://www.cloudshark.org/captures/f27d14944000"
        }
      }
    }, {
      "id" : 240001,
      "org_id" : 0,
      "start_time" : "2023-08-11T21:40:00.000+0000",
      "end_time" : "2023-08-11T21:45:00.000+0000",
      "device_id" : 123005,
      "hostname" : "host.name1",
      "mac_address" : "BCF310778641",
      "interface_name" : "WIFI0",
      "location_id" : 339506,
      "locations" : [ {
        "id" : 339506,
        "name" : "test-location"
      } ],
      "status" : "SUCCESS",
      "storage" : {
        "cloud_storage" : "123/627588202497/BCF310778641/627588202497-wifi0.pcap",
        "cloud_shark_storage" : {
          "file_name" : "20230809182410UTC-BCF310778641-wifi0.pcap",
          "file_url" : "https://www.cloudshark.org/captures/f27d14944001"
        }
      }
    } ],
    "cloud_storage" : "123/archive/230001-pcap.tar"
  }, {
    "id" : 230002,
    "start_time" : "2023-08-11T21:40:00.000+0000",
    "end_time" : "2023-08-11T21:45:15.000+0000",
    "org_id" : 0,
    "name" : "capture name 2",
    "duration" : 300,
    "capture_id_type" : "DEVICE_IDS",
    "device_ids" : [ 123000, 123005 ],
    "destination" : "CLOUD",
    "filter" : {
      "mac_addr" : [ "AABBCC001122" ],
      "ip_addr" : [ "192.168.11.255" ],
      "protocol" : "USER_DEFINED",
      "protocol_number" : 5,
      "port" : 1024,
      "vlan" : "2,3-5",
      "wlan" : "some-ssid"
    },
    "capture_if" : {
      "direction" : "BOTH",
      "radio" : "ALL",
      "wired_interface" : "ETH0",
      "wireless_band" : "2.4GHZ",
      "wired_filters" : [ "DHCP" ],
      "wireless_filters" : [ "DATA", "CONTROL" ]
    },
    "status" : "SUCCESS",
    "results" : [ {
      "id" : 240000,
      "org_id" : 0,
      "start_time" : "2023-08-11T21:40:00.000+0000",
      "end_time" : "2023-08-11T21:45:00.000+0000",
      "device_id" : 123000,
      "hostname" : "host.name0",
      "mac_address" : "BCF310778640",
      "interface_name" : "WIFI0",
      "location_id" : 339506,
      "locations" : [ {
        "id" : 339506,
        "name" : "test-location"
      } ],
      "status" : "SUCCESS",
      "storage" : {
        "cloud_storage" : "123/627588202497/BCF310778640/627588202497-wifi0.pcap",
        "cloud_shark_storage" : {
          "file_name" : "20230809182410UTC-BCF310778640-wifi0.pcap",
          "file_url" : "https://www.cloudshark.org/captures/f27d14944000"
        }
      }
    }, {
      "id" : 240001,
      "org_id" : 0,
      "start_time" : "2023-08-11T21:40:00.000+0000",
      "end_time" : "2023-08-11T21:45:00.000+0000",
      "device_id" : 123005,
      "hostname" : "host.name1",
      "mac_address" : "BCF310778641",
      "interface_name" : "WIFI0",
      "location_id" : 339506,
      "locations" : [ {
        "id" : 339506,
        "name" : "test-location"
      } ],
      "status" : "SUCCESS",
      "storage" : {
        "cloud_storage" : "123/627588202497/BCF310778641/627588202497-wifi0.pcap",
        "cloud_shark_storage" : {
          "file_name" : "20230809182410UTC-BCF310778641-wifi0.pcap",
          "file_url" : "https://www.cloudshark.org/captures/f27d14944001"
        }
      }
    } ],
    "cloud_storage" : "123/archive/230002-pcap.tar"
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/packetcaptures?searchString=Extreme' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEzMiwiZXhwIjoxNzEyNzc4OTMyfQ.1Rpjje_LO_ncIc-Y10G7-pDDTsPgM4IxjkSh1Pjyl0w' \
    -H 'Content-Type: application/json'

Create packet capture

POST /packetcaptures

Request Fields

Path Type Description

name

String

The packet capture session name. If the name is null or empty, it will be auto generated.

capture_id_type

String

The capture identifier type for selecting the APs. Depending on the type, one of "ap_serial_number", "device_ids" or "location_id" must be provided.

ap_serial_number

String

The globally unique serial number of the device being registered. The serial number is represented as a string.

device_ids

Array

The device ID list

location_id

Number

The assigned location ID, it must be FLOOR type

duration

Number

destination

String

The destination for the packet capture files. CLOUD for XIQ cloud storage. CLOUD_SHARK for sending the capture files to CloudShark, in addition to XIQ cloud storage.

filter

Object

This represents the properties of filters used for the packet capture.

filter.mac_addr

Array

List of the client MAC addresses used for packet capturing

filter.ip_addr

Array

List of the client IP addresses used to filter the packets

filter.protocol

String

Protocol type to filter by

filter.protocol_number

Number

The protocol number if protocol is "USER_DEFINED"

filter.port

Number

The port for packet capture

filter.vlan

String

Specific vlan ids in a string, e.g. range "2-100"; single "3"; list "1,2,5,7,122"; mixed "2,4,5-10,19,29". If not specified, default is all VLANs.

filter.wlan

String

A WLAN SSID. If not specified, default is all WLANs.

capture_if

Object

This represents the options for location packet capture.

capture_if.direction

String

The capture traffic direction

capture_if.radio

String

The wireless radio to capture. Set to ALL for all radios.

capture_if.wireless_band

String

The wireless band to capture. Set to ALL for all bands.

capture_if.wired_interface

String

The name of the wired interface to capture. Set to ALL for all interfaces.

capture_if.wired_filters

Array

The list of pre-defined wired filters for packet capture

capture_if.wireless_filters

Array

The list of pre-defined wireless filters for packet capture

HTTP Request

POST /packetcaptures HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEzMSwiZXhwIjoxNzEyNzc4OTMxfQ.Wx5BF8Z4kx7lPdSvCuqiX5i5E8P_gZIc0fqzJgckiOg
Host: api.extremecloudiq.com
Content-Length: 559
Content-Type: application/json

{
  "duration" : 300,
  "capture_id_type" : "DEVICE_IDS",
  "device_ids" : [ 123000, 123005 ],
  "destination" : "CLOUD",
  "filter" : {
    "mac_addr" : [ "AABBCC001122" ],
    "ip_addr" : [ "192.168.11.255" ],
    "protocol" : "USER_DEFINED",
    "protocol_number" : 5,
    "port" : 1024,
    "vlan" : "2,3-5",
    "wlan" : "some-ssid"
  },
  "capture_if" : {
    "direction" : "BOTH",
    "radio" : "ALL",
    "wired_interface" : "ETH0",
    "wireless_band" : "2.4GHZ",
    "wired_filters" : [ "DHCP" ],
    "wireless_filters" : [ "DATA", "CONTROL" ]
  }
}

Response Fields

Path Type Description

id

Number

The packet capture ID.

start_time

String

The packet capture start time

end_time

String

The packet capture end time

org_id

Number

The organization identifier, valid when enabling HIQ feature.

name

String

The packet capture session name. If the name is null or empty, it will be auto generated.

capture_id_type

String

The capture identifier type for selecting the APs. Depending on the type, one of "ap_serial_number", "device_ids" or "location_id" must be provided.

ap_serial_number

String

The globally unique serial number of the device being registered. The serial number is represented as a string.

device_ids

Array

The device ID list

location_id

Number

The assigned location ID, it must be FLOOR type

duration

Number

destination

String

The destination for the packet capture files. CLOUD for XIQ cloud storage. CLOUD_SHARK for sending the capture files to CloudShark, in addition to XIQ cloud storage.

filter

Object

This represents the properties of filters used for the packet capture.

filter.mac_addr

Array

List of the client MAC addresses used for packet capturing

filter.ip_addr

Array

List of the client IP addresses used to filter the packets

filter.protocol

String

Protocol type to filter by

filter.protocol_number

Number

The protocol number if protocol is "USER_DEFINED"

filter.port

Number

The port for packet capture

filter.vlan

String

Specific vlan ids in a string, e.g. range "2-100"; single "3"; list "1,2,5,7,122"; mixed "2,4,5-10,19,29". If not specified, default is all VLANs.

filter.wlan

String

A WLAN SSID. If not specified, default is all WLANs.

capture_if

Object

This represents the options for location packet capture.

capture_if.direction

String

The capture traffic direction

capture_if.radio

String

The wireless radio to capture. Set to ALL for all radios.

capture_if.wireless_band

String

The wireless band to capture. Set to ALL for all bands.

capture_if.wired_interface

String

The name of the wired interface to capture. Set to ALL for all interfaces.

capture_if.wired_filters

Array

The list of pre-defined wired filters for packet capture

capture_if.wireless_filters

Array

The list of pre-defined wireless filters for packet capture

status

String

The status of the packet capture session

cloud_storage

String

XIQ cloud storage location for the archive of all capture files in this capture session, if available.

results

Array

The list of packet capture results - a PacketCaptureResult for each device’s interface

results[].id

Number

The packet capture result ID

results[].org_id

Number

The organization identifier, valid when enabling HIQ feature

results[].device_id

Number

The device identifier

results[].hostname

String

The device host name

results[].interface_name

String

The interface name such as "WIFI0", "WIFI1", "ETH0", etc.

results[].location_id

Number

The location ID

results[].locations

Array

The detailed location

results[].locations[].id

Number

The location ID

results[].locations[].name

String

The location name

results[].mac_address

String

The device MAC address

results[].status

String

The status of the packet capture result

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: 1420
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: 7371

{
  "id" : 230001,
  "start_time" : "2023-08-11T21:40:00.000+0000",
  "end_time" : "2023-08-11T21:45:15.000+0000",
  "org_id" : 0,
  "name" : "capture name 1",
  "duration" : 300,
  "capture_id_type" : "DEVICE_IDS",
  "device_ids" : [ 123000, 123005 ],
  "destination" : "CLOUD",
  "filter" : {
    "mac_addr" : [ "AABBCC001122" ],
    "ip_addr" : [ "192.168.11.255" ],
    "protocol" : "USER_DEFINED",
    "protocol_number" : 5,
    "port" : 1024,
    "vlan" : "2,3-5",
    "wlan" : "some-ssid"
  },
  "capture_if" : {
    "direction" : "BOTH",
    "radio" : "ALL",
    "wired_interface" : "ETH0",
    "wireless_band" : "2.4GHZ",
    "wired_filters" : [ "DHCP" ],
    "wireless_filters" : [ "DATA", "CONTROL" ]
  },
  "status" : "INITIAL",
  "results" : [ {
    "id" : 240000,
    "org_id" : 0,
    "device_id" : 123000,
    "hostname" : "host.name0",
    "mac_address" : "BCF310778640",
    "interface_name" : "WIFI0",
    "location_id" : 339506,
    "locations" : [ {
      "id" : 339506,
      "name" : "test-location"
    } ],
    "status" : "INITIAL"
  }, {
    "id" : 240001,
    "org_id" : 0,
    "device_id" : 123005,
    "hostname" : "host.name1",
    "mac_address" : "BCF310778641",
    "interface_name" : "WIFI0",
    "location_id" : 339506,
    "locations" : [ {
      "id" : 339506,
      "name" : "test-location"
    } ],
    "status" : "INITIAL"
  } ],
  "cloud_storage" : "123/archive/230001-pcap.tar"
}

cURL Request

$ curl 'https://api.extremecloudiq.com/packetcaptures' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEzMSwiZXhwIjoxNzEyNzc4OTMxfQ.Wx5BF8Z4kx7lPdSvCuqiX5i5E8P_gZIc0fqzJgckiOg' \
    -H 'Content-Type: application/json' \
    -d '{
  "duration" : 300,
  "capture_id_type" : "DEVICE_IDS",
  "device_ids" : [ 123000, 123005 ],
  "destination" : "CLOUD",
  "filter" : {
    "mac_addr" : [ "AABBCC001122" ],
    "ip_addr" : [ "192.168.11.255" ],
    "protocol" : "USER_DEFINED",
    "protocol_number" : 5,
    "port" : 1024,
    "vlan" : "2,3-5",
    "wlan" : "some-ssid"
  },
  "capture_if" : {
    "direction" : "BOTH",
    "radio" : "ALL",
    "wired_interface" : "ETH0",
    "wireless_band" : "2.4GHZ",
    "wired_filters" : [ "DHCP" ],
    "wireless_filters" : [ "DATA", "CONTROL" ]
  }
}'

Get packet capture

GET /packetcaptures/{id}

Path parameters

Table 135. /packetcaptures/{id}
Parameter	Description
`id`	Packet Capture ID

Request Parameters

Parameter Description

fields

HTTP Request

GET /packetcaptures/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEzMiwiZXhwIjoxNzEyNzc4OTMyfQ.1Rpjje_LO_ncIc-Y10G7-pDDTsPgM4IxjkSh1Pjyl0w
Content-Type: application/json

Response Fields

Path Type Description

id

Number

The packet capture ID.

start_time

String

The packet capture start time

end_time

String

The packet capture end time

org_id

Number

The organization identifier, valid when enabling HIQ feature.

name

String

The packet capture session name. If the name is null or empty, it will be auto generated.

capture_id_type

String

The capture identifier type for selecting the APs. Depending on the type, one of "ap_serial_number", "device_ids" or "location_id" must be provided.

ap_serial_number

String

The globally unique serial number of the device being registered. The serial number is represented as a string.

device_ids

Array

The device ID list

location_id

Number

The assigned location ID, it must be FLOOR type

duration

Number

destination

String

The destination for the packet capture files. CLOUD for XIQ cloud storage. CLOUD_SHARK for sending the capture files to CloudShark, in addition to XIQ cloud storage.

filter

Object

This represents the properties of filters used for the packet capture.

filter.mac_addr

Array

List of the client MAC addresses used for packet capturing

filter.ip_addr

Array

List of the client IP addresses used to filter the packets

filter.protocol

String

Protocol type to filter by

filter.protocol_number

Number

The protocol number if protocol is "USER_DEFINED"

filter.port

Number

The port for packet capture

filter.vlan

String

Specific vlan ids in a string, e.g. range "2-100"; single "3"; list "1,2,5,7,122"; mixed "2,4,5-10,19,29". If not specified, default is all VLANs.

filter.wlan

String

A WLAN SSID. If not specified, default is all WLANs.

capture_if

Object

This represents the options for location packet capture.

capture_if.direction

String

The capture traffic direction

capture_if.radio

String

The wireless radio to capture. Set to ALL for all radios.

capture_if.wireless_band

String

The wireless band to capture. Set to ALL for all bands.

capture_if.wired_interface

String

The name of the wired interface to capture. Set to ALL for all interfaces.

capture_if.wired_filters

Array

The list of pre-defined wired filters for packet capture

capture_if.wireless_filters

Array

The list of pre-defined wireless filters for packet capture

status

String

The status of the packet capture session

cloud_storage

String

XIQ cloud storage location for the archive of all capture files in this capture session, if available.

results

Array

The list of packet capture results - a PacketCaptureResult for each device’s interface

results[].id

Number

The packet capture result ID

results[].org_id

Number

The organization identifier, valid when enabling HIQ feature

results[].device_id

Number

The device identifier

results[].hostname

String

The device host name

results[].interface_name

String

The interface name such as "WIFI0", "WIFI1", "ETH0", etc.

results[].location_id

Number

The location ID

results[].locations

Array

The detailed location

results[].locations[].id

Number

The location ID

results[].locations[].name

String

The location name

results[].mac_address

String

The device MAC address

results[].status

String

The status of the packet capture result

results[].start_time

String

The packet capture start time

results[].end_time

String

The packet capture end time

results[].error_message

String

The error message (may be empty)

results[].storage.cloud_storage

String

XIQ cloud storage location after a packet capture is completed

results[].storage.cloud_shark_storage

Object

The packet capture file name and URL in CloudShark

results[].storage.cloud_shark_storage.file_name

String

File name in CloudShark

results[].storage.cloud_shark_storage.file_url

String

File URL in CloudShark

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: 7368
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: 2190

{
  "id" : 230001,
  "start_time" : "2023-08-11T21:40:00.000+0000",
  "end_time" : "2023-08-11T21:45:15.000+0000",
  "org_id" : 0,
  "name" : "capture name 1",
  "duration" : 300,
  "capture_id_type" : "DEVICE_IDS",
  "device_ids" : [ 123000, 123005 ],
  "destination" : "CLOUD",
  "filter" : {
    "mac_addr" : [ "AABBCC001122" ],
    "ip_addr" : [ "192.168.11.255" ],
    "protocol" : "USER_DEFINED",
    "protocol_number" : 5,
    "port" : 1024,
    "vlan" : "2,3-5",
    "wlan" : "some-ssid"
  },
  "capture_if" : {
    "direction" : "BOTH",
    "radio" : "ALL",
    "wired_interface" : "ETH0",
    "wireless_band" : "2.4GHZ",
    "wired_filters" : [ "DHCP" ],
    "wireless_filters" : [ "DATA", "CONTROL" ]
  },
  "status" : "SUCCESS",
  "results" : [ {
    "id" : 240000,
    "org_id" : 0,
    "start_time" : "2023-08-11T21:40:00.000+0000",
    "end_time" : "2023-08-11T21:45:00.000+0000",
    "device_id" : 123000,
    "hostname" : "host.name0",
    "mac_address" : "BCF310778640",
    "interface_name" : "WIFI0",
    "location_id" : 339506,
    "locations" : [ {
      "id" : 339506,
      "name" : "test-location"
    } ],
    "status" : "SUCCESS",
    "storage" : {
      "cloud_storage" : "123/627588202497/BCF310778640/627588202497-wifi0.pcap",
      "cloud_shark_storage" : {
        "file_name" : "20230809182410UTC-BCF310778640-wifi0.pcap",
        "file_url" : "https://www.cloudshark.org/captures/f27d14944000"
      }
    }
  }, {
    "id" : 240001,
    "org_id" : 0,
    "start_time" : "2023-08-11T21:40:00.000+0000",
    "end_time" : "2023-08-11T21:45:00.000+0000",
    "device_id" : 123005,
    "hostname" : "host.name1",
    "mac_address" : "BCF310778641",
    "interface_name" : "WIFI0",
    "location_id" : 339506,
    "locations" : [ {
      "id" : 339506,
      "name" : "test-location"
    } ],
    "status" : "SUCCESS",
    "storage" : {
      "cloud_storage" : "123/627588202497/BCF310778641/627588202497-wifi0.pcap",
      "cloud_shark_storage" : {
        "file_name" : "20230809182410UTC-BCF310778641-wifi0.pcap",
        "file_url" : "https://www.cloudshark.org/captures/f27d14944001"
      }
    }
  } ],
  "cloud_storage" : "123/archive/230001-pcap.tar"
}

cURL Request

$ curl 'https://api.extremecloudiq.com/packetcaptures/438086664193' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEzMiwiZXhwIjoxNzEyNzc4OTMyfQ.1Rpjje_LO_ncIc-Y10G7-pDDTsPgM4IxjkSh1Pjyl0w' \
    -H 'Content-Type: application/json'

Delete packet capture

DELETE /packetcaptures/{id}

Path parameters

Table 136. /packetcaptures/{id}
Parameter	Description
`id`	Packet Capture ID

HTTP Request

DELETE /packetcaptures/438086664193 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEzMiwiZXhwIjoxNzEyNzc4OTMyfQ.1Rpjje_LO_ncIc-Y10G7-pDDTsPgM4IxjkSh1Pjyl0w
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: 7369
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate

cURL Request

$ curl 'https://api.extremecloudiq.com/packetcaptures/438086664193' -i -X DELETE \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEzMiwiZXhwIjoxNzEyNzc4OTMyfQ.1Rpjje_LO_ncIc-Y10G7-pDDTsPgM4IxjkSh1Pjyl0w' \
    -H 'Content-Type: application/json'

Stop active packet capture

POST /packetcaptures/{id}/:stop

Path parameters

Table 137. /clients/{id}
Parameter	Description
`id`	Client ID

Request Body

{ }

HTTP Request

POST /packetcaptures/438086664193/:stop HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEzMiwiZXhwIjoxNzEyNzc4OTMyfQ.1Rpjje_LO_ncIc-Y10G7-pDDTsPgM4IxjkSh1Pjyl0w
Content-Type: application/json
Content-Length: 3

{ }

HTTP Response

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

cURL Request

$ curl 'https://api.extremecloudiq.com/packetcaptures/438086664193/:stop' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEzMiwiZXhwIjoxNzEyNzc4OTMyfQ.1Rpjje_LO_ncIc-Y10G7-pDDTsPgM4IxjkSh1Pjyl0w' \
    -H 'Content-Type: application/json' \
    -d '{ }'

Upload packet capture’s capture files

POST /packetcaptures/{id}/:upload

Path parameters

Table 138. /packetcaptures/{id}/:upload
Parameter	Description
`id`	Packet Capture ID

HTTP Request

POST /packetcaptures/438086664193/:upload HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEzMSwiZXhwIjoxNzEyNzc4OTMxfQ.Wx5BF8Z4kx7lPdSvCuqiX5i5E8P_gZIc0fqzJgckiOg
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
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
RateLimit-Remaining: 7372

cURL Request

$ curl 'https://api.extremecloudiq.com/packetcaptures/438086664193/:upload' -i -X POST \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEzMSwiZXhwIjoxNzEyNzc4OTMxfQ.Wx5BF8Z4kx7lPdSvCuqiX5i5E8P_gZIc0fqzJgckiOg' \
    -H 'Content-Type: application/json'

Get packet capture file

GET /packetcaptures/files

Request Parameters

Parameter Description

cloudFileUrl

The packet capture file path

HTTP Request

GET /packetcaptures/files?cloudFileUrl=123%2F627588202497%2FBCF310778640%2F627588202497-wifi2.pcap HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEzMSwiZXhwIjoxNzEyNzc4OTMxfQ.Wx5BF8Z4kx7lPdSvCuqiX5i5E8P_gZIc0fqzJgckiOg
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
Content-Disposition: attachment; filename=""
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Length: 122
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
RateLimit-Remaining: 7371
Content-Type: application/octet-stream

/var/lib/jenkins/workspace/XIQ-RELEASE-BUILDS/RELEASE-24R3/xcloudiq-api/xcloudiq-api-gateway/target/test-classes/test.pcap

cURL Request

$ curl 'https://api.extremecloudiq.com/packetcaptures/files?cloudFileUrl=123%2F627588202497%2FBCF310778640%2F627588202497-wifi2.pcap' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEzMSwiZXhwIjoxNzEyNzc4OTMxfQ.Wx5BF8Z4kx7lPdSvCuqiX5i5E8P_gZIc0fqzJgckiOg' \
    -H 'Content-Type: application/json'

Network Scorecard

Get device’s overall health for given location

GET /network-scorecard/deviceHealth/{locationId}

Path parameters

Table 139. /network-scorecard/deviceHealth/{locationId}
Parameter	Description
`locationId`	The location ID

Request Parameters

Parameter Description

startTime

The start time for querying device health. unit: milliseconds

endTime

The end time for querying device health. unit: milliseconds

HTTP Request

GET /network-scorecard/deviceHealth/438086664193?startTime=1&endTime=2 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEzMSwiZXhwIjoxNzEyNzc4OTMxfQ.Wx5BF8Z4kx7lPdSvCuqiX5i5E8P_gZIc0fqzJgckiOg
Host: api.extremecloudiq.com
Content-Type: application/json

Response Fields

Path Type Description

score

Number

The overall health score

device_availability_score

Number

The device availability score

device_hardware_health_score

Number

The device hardware health score

config_and_firmware_score

Number

The config and firmware score

HTTP Response

HTTP/1.1 200 OK
RateLimit-Remaining: 7375
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Content-Length: 132
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

{
  "score" : 100,
  "device_availability_score" : 100,
  "device_hardware_health_score" : 100,
  "config_and_firmware_score" : 98
}

cURL Request

$ curl 'https://api.extremecloudiq.com/network-scorecard/deviceHealth/438086664193?startTime=1&endTime=2' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEzMSwiZXhwIjoxNzEyNzc4OTMxfQ.Wx5BF8Z4kx7lPdSvCuqiX5i5E8P_gZIc0fqzJgckiOg' \
    -H 'Content-Type: application/json'

Get clients' overall health for given location

GET /network-scorecard/clientHealth/{locationId}

Path parameters

Table 140. /network-scorecard/clientHealth/{locationId}
Parameter	Description
`locationId`	The location ID

Request Parameters

Parameter Description

startTime

The start time for querying client health. unit: milliseconds

endTime

The end time for querying client health. unit: milliseconds

HTTP Request

GET /network-scorecard/clientHealth/438086664193?startTime=1&endTime=2 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEzMSwiZXhwIjoxNzEyNzc4OTMxfQ.Wx5BF8Z4kx7lPdSvCuqiX5i5E8P_gZIc0fqzJgckiOg
Host: api.extremecloudiq.com
Content-Type: application/json

Response Fields

Path Type Description

overall_score

Number

The overall health score

wifi_health_score

Number

The health score of wifi

network_health_score

Number

The health score of network

application_health_score

Number

The health score of application

HTTP Response

HTTP/1.1 200 OK
RateLimit-Remaining: 7374
Pragma: no-cache
RateLimit-Limit: 7500;w=3600
X-XSS-Protection: 1; mode=block
Expires: 0
X-Content-Type-Options: nosniff
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: 124

{
  "overall_score" : 100,
  "wifi_health_score" : 100,
  "network_health_score" : 100,
  "application_health_score" : 100
}

cURL Request

$ curl 'https://api.extremecloudiq.com/network-scorecard/clientHealth/438086664193?startTime=1&endTime=2' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEzMSwiZXhwIjoxNzEyNzc4OTMxfQ.Wx5BF8Z4kx7lPdSvCuqiX5i5E8P_gZIc0fqzJgckiOg' \
    -H 'Content-Type: application/json'

Get Wi-Fi’s overall health for given location

GET /network-scorecard/wifiHealth/{locationId}

Path parameters

Table 141. /network-scorecard/wifiHealth/{locationId}
Parameter	Description
`locationId`	The location ID

Request Parameters

Parameter Description

startTime

The start time for querying wifi health. unit: milliseconds

endTime

The end time for querying wifi health. unit: milliseconds

HTTP Request

GET /network-scorecard/wifiHealth/438086664193?startTime=1&endTime=2 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEzMSwiZXhwIjoxNzEyNzc4OTMxfQ.Wx5BF8Z4kx7lPdSvCuqiX5i5E8P_gZIc0fqzJgckiOg
Host: api.extremecloudiq.com
Content-Type: application/json

Response Fields

Path Type Description

overall_score

Number

The overall health score

snr_score

Number

The health score of snr

channel_utilization_score

Number

The health score of utilization

association_per_radio_score

Number

The health score of association

HTTP Response

HTTP/1.1 200 OK
Pragma: no-cache
RateLimit-Remaining: 7376
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: 123

{
  "overall_score" : 100,
  "snr_score" : 100,
  "channel_utilization_score" : 96,
  "association_per_radio_score" : 100
}

cURL Request

$ curl 'https://api.extremecloudiq.com/network-scorecard/wifiHealth/438086664193?startTime=1&endTime=2' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEzMSwiZXhwIjoxNzEyNzc4OTMxfQ.Wx5BF8Z4kx7lPdSvCuqiX5i5E8P_gZIc0fqzJgckiOg' \
    -H 'Content-Type: application/json'

Get network’s overall health for given location

GET /network-scorecard/networkHealth/{locationId}

Path parameters

Table 142. /network-scorecard/networkHealth/{locationId}
Parameter	Description
`locationId`	The location ID

Request Parameters

Parameter Description

startTime

The start time for querying network health. unit: milliseconds

endTime

The end time for querying network health. unit: milliseconds

HTTP Request

GET /network-scorecard/networkHealth/438086664193?startTime=1&endTime=2 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEzMSwiZXhwIjoxNzEyNzc4OTMxfQ.Wx5BF8Z4kx7lPdSvCuqiX5i5E8P_gZIc0fqzJgckiOg
Host: api.extremecloudiq.com
Content-Type: application/json

Response Fields

Path Type Description

overall_score

Number

The overall health score

internet_availability_score

Number

The overall internet availability score

internet_performance

Number

The internet performance value in milli-seconds

network_usage

Number

The network usage value in MB

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: 126
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: 7373

{
  "overall_score" : 100,
  "internet_availability_score" : 100,
  "internet_performance" : 0,
  "network_usage" : 24048116
}

cURL Request

$ curl 'https://api.extremecloudiq.com/network-scorecard/networkHealth/438086664193?startTime=1&endTime=2' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEzMSwiZXhwIjoxNzEyNzc4OTMxfQ.Wx5BF8Z4kx7lPdSvCuqiX5i5E8P_gZIc0fqzJgckiOg' \
    -H 'Content-Type: application/json'

Get services' overall health for given location

GET /network-scorecard/servicesHealth/{locationId}

Path parameters

Table 143. /network-scorecard/servicesHealth/{locationId}
Parameter	Description
`locationId`	The location ID

Request Parameters

Parameter Description

startTime

The start time for querying services health. unit: milliseconds

endTime

The end time for querying services health. unit: milliseconds

HTTP Request

GET /network-scorecard/servicesHealth/438086664193?startTime=1&endTime=2 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEzMSwiZXhwIjoxNzEyNzc4OTMxfQ.Wx5BF8Z4kx7lPdSvCuqiX5i5E8P_gZIc0fqzJgckiOg
Host: api.extremecloudiq.com
Content-Type: application/json

Response Fields

Path Type Description

overall_score

Number

The overall health score

network_services_score

Number

The health score of network services

authentication_services_score

Number

The health score of authentication services

management_services_score

Number

The health score of management services

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: 7372
Content-Length: 135

{
  "overall_score" : 98,
  "network_services_score" : 97,
  "authentication_services_score" : 100,
  "management_services_score" : 0
}

cURL Request

$ curl 'https://api.extremecloudiq.com/network-scorecard/servicesHealth/438086664193?startTime=1&endTime=2' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEzMSwiZXhwIjoxNzEyNzc4OTMxfQ.Wx5BF8Z4kx7lPdSvCuqiX5i5E8P_gZIc0fqzJgckiOg' \
    -H 'Content-Type: application/json'

Essentials - ExtremeLocation

Get last known location of the client

GET /essentials/eloc/clients/{clientMac}/last-known-location

Path parameters

Table 144. /essentials/eloc/clients/{clientMac}/last-known-location
Parameter	Description
`clientMac`	The mac address of client

Request Parameters

Parameter Description

floorId

Location Id of the floor

parentId

Location Id of the floor’s parent

HTTP Request

GET /essentials/eloc/clients/00:00:00:01:aa/last-known-location?floorId=1625038306000&parentId=1625038306001 HTTP/1.1
Host: api.extremecloudiq.com
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEzNiwiZXhwIjoxNzEyNzc4OTM2fQ.-rcLkJgzYaMEjlmx0jQeYziIcr5U6KiGSdCQms9cdPw
Content-Type: application/json

Response Fields

Path Type Description

timestamp

String

The located client’s last known timestamp in format of date, time and abbreviated timezone.

x

Number

The located client’s last known horizontal value on the floor plan.

y

Number

The located client’s last known vertical value on the floor plan.

HTTP Response

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

{
  "timestamp" : "May 02, 2023 06:54:56 AM EDT",
  "x" : 99.1,
  "y" : 99.1
}

cURL Request

$ curl 'https://api.extremecloudiq.com/essentials/eloc/clients/00:00:00:01:aa/last-known-location?floorId=1625038306000&parentId=1625038306001' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDEzNiwiZXhwIjoxNzEyNzc4OTM2fQ.-rcLkJgzYaMEjlmx0jQeYziIcr5U6KiGSdCQms9cdPw' \
    -H 'Content-Type: application/json'

Misc

Get list of countries and country codes.

GET /countries

HTTP Request

GET /countries HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0NiwiZXhwIjoxNzEyNzc4OTQ2fQ.zdl66E7fxQx8ncNAcycvOE6q9-xJLhs0joZJxksGxGo
Host: api.extremecloudiq.com
Content-Type: application/json

Response Fields

Path Type Description

[].dial_code

String

The dialing code for international calls, typically prefixed by the '+' key for mobile.

[].alpha2_code

String

The country ISO 2-letter code

[].country_code

Number

The country ISO 3-digit code

[].internal_country_codes

Array

The Extreme IQ internal country codes.

[].short_name

String

The country (short) name

[].name_en

String

The country official name in English.

[].name_jp

String

The country official name in Japanese.

[].name_fr

String

The country official name in French.

[].name_de

String

The country official name in German.

[].name_it

String

The country official name in Italian.

[].name_pt

String

The country official name in Portuguese

[].name_zh

String

The country official name in Chinese.

[].name_es

String

The country official name in Spanish.

[].name_ko

String

The country official name in Korean

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: 758
RateLimit-Remaining: 7327
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

[ {
  "dial_code" : "+1",
  "alpha2_code" : "JP",
  "country_code" : 392,
  "internal_country_codes" : [ 4014 ],
  "short_name" : "Japan",
  "name_en" : "Japan",
  "name_jp" : "日本",
  "name_fr" : "Japon",
  "name_de" : "Japan",
  "name_it" : "Giappone",
  "name_pt" : "Japão",
  "name_zh" : "日本",
  "name_es" : "Japón",
  "name_ko" : "일본"
}, {
  "dial_code" : "+44",
  "alpha2_code" : "GB",
  "country_code" : 826,
  "internal_country_codes" : [ ],
  "short_name" : "United Kingdom",
  "name_en" : "United States",
  "name_jp" : "イギリス",
  "name_fr" : "Royaume-Uni",
  "name_de" : "Großbritannien",
  "name_it" : "Regno Unito",
  "name_pt" : "Reino Unido",
  "name_zh" : "英国",
  "name_es" : "Reino Unido",
  "name_ko" : "영국"
} ]

cURL Request

$ curl 'https://api.extremecloudiq.com/countries' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0NiwiZXhwIjoxNzEyNzc4OTQ2fQ.zdl66E7fxQx8ncNAcycvOE6q9-xJLhs0joZJxksGxGo' \
    -H 'Content-Type: application/json'

Validate country code

GET /countries/{countryCode}/:validate

Path parameters

Table 145. /countries/{countryCode}/:validate
Parameter	Description
`countryCode`	The country code to validate

HTTP Request

GET /countries/840/:validate HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0NiwiZXhwIjoxNzEyNzc4OTQ2fQ.zdl66E7fxQx8ncNAcycvOE6q9-xJLhs0joZJxksGxGo
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: 7326
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: 4

true

cURL Request

$ curl 'https://api.extremecloudiq.com/countries/840/:validate' -i -X GET \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE0NiwiZXhwIjoxNzEyNzc4OTQ2fQ.zdl66E7fxQx8ncNAcycvOE6q9-xJLhs0joZJxksGxGo' \
    -H 'Content-Type: application/json'

Unresolved directive in reference/index.adoc - include::license/index.adoc[]

Thread Network

Get Thread Networks

GET /thread/networks

Request Parameters

Parameter Description

page

Page number

limit

Page size

folderId

Site folder ID

views

A view is a collection of thread network fields: Basic View or Full View

fields

The thread network fields to return: id, channel, channel_mask, ext_pan_id, mesh_local_prefix, network_key, network_name, pan_id, pskc, obtain_network_key_enabled, native_commissioning_enabled, routers_enabled, external_commissioning_enabled, beacons_enabled, commercial_commissioning_enabled, autonomous_enrollment_enabled, network_key_provisioning_enabled, non_ccm_routers_enabled, activeTimestamp,

HTTP Request

GET /thread/networks?page=1&limit=10&folderId=438086664193&views=FULL&fields=ID%2CCHANNEL HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE4MSwiZXhwIjoxNzEyNzc4OTgxfQ.764zU3FrIUrpSoZgyq3pLyouyWkc0vYfgOcbLi24lqU

Response Fields

Path Type Description

networks[].id

Number

Unique Identifier of Thread Network

networks[].channel

Number

Channel

networks[].channel_mask

String

Channel Mask

networks[].ext_pan_id

String

Ext Pan ID

networks[].mesh_local_prefix

String

Mesh Local Prefix

networks[].network_key

String

Network Key

networks[].network_name

String

Network Name

networks[].pan_id

String

Pan ID

networks[].pskc

String

PSKC

networks[].obtain_network_key_enabled

Boolean

Obtain Network Key Enabled

networks[].native_commissioning_enabled

Boolean

Native Commissioning Enabled

networks[].routers_enabled

Boolean

Router Enabled

networks[].external_commissioning_enabled

Boolean

External Commissioning Enabled

networks[].beacons_enabled

Boolean

Beacons Enabled

networks[].commercial_commissioning_enabled

Boolean

Commercial Commissioning Enabled

networks[].autonomous_enrollment_enabled

Boolean

Autonomous Enrollment Enabled

networks[].network_key_provisioning_enabled

Boolean

Network Key Provisioning Enabled

networks[].non_ccm_routers_enabled

Boolean

Non CCM Routers Enabled

networks[].active_timestamp

Number

Active Timestamp

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: 689
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: 7241

{
  "networks" : [ {
    "id" : 2,
    "channel" : 11,
    "channel_mask" : "channel-mask",
    "ext_pan_id" : "ext-pan-id",
    "mesh_local_prefix" : "mesh-local-prefix",
    "network_key" : "network-key",
    "network_name" : "network-name",
    "pan_id" : "pan-id",
    "pskc" : "pskc",
    "obtain_network_key_enabled" : true,
    "native_commissioning_enabled" : true,
    "routers_enabled" : true,
    "external_commissioning_enabled" : true,
    "beacons_enabled" : true,
    "commercial_commissioning_enabled" : true,
    "autonomous_enrollment_enabled" : true,
    "network_key_provisioning_enabled" : true,
    "non_ccm_routers_enabled" : true,
    "active_timestamp" : 1
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/thread/networks?page=1&limit=10&folderId=438086664193&views=FULL&fields=ID%2CCHANNEL' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE4MSwiZXhwIjoxNzEyNzc4OTgxfQ.764zU3FrIUrpSoZgyq3pLyouyWkc0vYfgOcbLi24lqU'

Get Thread Network Topology

GET /thread/topology

Request Parameters

Parameter Description

clientViews

Thread Client Views

clientFields

Thread Client Fields

routerViews

Thread Router Fields

networkConfigIds

Thread Network Config IDs

routerFields

Thread Router Fields

HTTP Request

GET /thread/topology?networkConfigIds=1%2C2&routerFields=DEVICE_ID%2CSERIAL_NUMBER&routerViews=BASIC&clientViews=THREAD&clientFields=ID%2CORG_ID HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE4MSwiZXhwIjoxNzEyNzc4OTgxfQ.764zU3FrIUrpSoZgyq3pLyouyWkc0vYfgOcbLi24lqU

Response Fields

Path Type Description

neighbors[]

Array

Thread Neighbors

neighbors[].parent_device_id

Number

Parent Device ID

neighbors[].child_device_id

Number

Child Device ID

neighbors[].last_reported_time

Number

Last Reported Timestamp by AP

routers[].id

Number

Thread Router Unique ID

routers[].org_id

Number

Org ID

routers[].owner_id

Number

Owner ID

routers[].device_id

Number

Device Unique ID

routers[].serial_number

String

Device Serial Number

routers[].eui64

String

EUI 64

routers[].ext_mac

String

Extended Mac Address

routers[].rloc16

String

RLOC16

routers[].global_ipv6

String

Global IPv6

routers[].tx_power

Number

TX Power

routers[].region

String

Region

routers[].thread_platform

String

Thread Platform

routers[].device_role

String

Device Role

routers[].active_clients

Number

Active Thread Clients Count

routers[].hostname

String

Device Hostname

routers[].last_reported

String

Last Reported Time by AP

routers[].thread_connected

Boolean

Thread Connected

routers[].router_interface.interface_name

String

Router Interface Name

routers[].router_interface.is_active

Boolean

Router Interface - Active

routers[].router_interface.is_broadcast

Boolean

Router Interface - Broadcast

routers[].router_interface.is_loopback

Boolean

Router Interface - Loopback

routers[].router_interface.is_point_to_point

Boolean

Router Interface - Point to Point

routers[].router_interface.is_running

Boolean

Router Interface - Running

routers[].router_interface.is_arp

Boolean

Router Interface - ARP

routers[].router_interface.is_promisc

Boolean

Router Interface - Promisc

routers[].router_interface.is_all_multi

Boolean

Router Interface - All Multi

routers[].router_interface.is_multicast

Boolean

Router Interface - Multicast

routers[].router_interface.is_dynamic

Boolean

Router Interface - Dynamic

routers[].router_interface.mtu

Number

Router Interface - MTU

routers[].router_interface.hw_mac_address

String

Router Interface - Mac Address

routers[].router_interface.ipv4

String

Router Interface - IPv4

routers[].router_interface.ipv4_mask

String

Router Interface - Mask

routers[].router_interface.ipv4_broadcast

String

Router Interface - IPv4 Broadcast

routers[].router_interface.ipv6_settings

Array

Router Interface - IPv6 Settings

routers[].veth0.interface_name

String

VETH0 - Interface Name

routers[].veth0.is_active

Boolean

VETH0 - Active

routers[].veth0.is_broadcast

Boolean

VETH0 - Broadcast

routers[].veth0.is_loopback

Boolean

VETH0 - Loopback

routers[].veth0.is_point_to_point

Boolean

VETH0 - Point to Point

routers[].veth0.is_running

Boolean

VETH0 - Running

routers[].veth0.is_arp

Boolean

VETH0 - ARP

routers[].veth0.is_promisc

Boolean

VETH0 - Promisc

routers[].veth0.is_all_multi

Boolean

VETH0 - Multi

routers[].veth0.is_multicast

Boolean

VETH0 - Multicast

routers[].veth0.is_dynamic

Boolean

VETH0 - Dynamic

routers[].veth0.mtu

Number

VETH0 - MTU

routers[].veth0.hw_mac_address

String

VETH0 - HW Mac Address

routers[].veth0.ipv4

String

VETH0 - IPv4 Address

routers[].veth0.ipv4_mask

String

VETH0 - IPv4 Address Mask

routers[].veth0.ipv4_broadcast

String

VETH0 - IPv4 Address Broadcast

routers[].veth0.ipv6_settings

Array

VETH0 - IPv6 Settings

routers[].network_data.length

Number

Network Data - Length

routers[].network_data.max_length

Number

Network Data - Max Length

routers[].network_data.net_data_on_mesh_prefixes

Array

Network Data - Net Data On-Mesh Prefixes

routers[].network_data.net_data_routes

Array

Network Data - Net Data Routes

routers[].network_data.net_data_services

Array

Network Data - Services

routers[].thread_mle_link_mode.rx_on_when_idle

Boolean

Thread MLE Link Mode - Rx-On When Idle

routers[].thread_mle_link_mode.full_thread_device

Boolean

Thread MLE Link Mode - Full Thread Device

routers[].thread_mle_link_mode.full_network_data

Boolean

Thread MLE Link Mode - Full Network Data

routers[].thread_version.thread_version

String

Thread - Version

routers[].thread_version.build_version

String

Thread - Build Version

routers[].thread_version.api_version

String

Thread - API Version

routers[].thread_version.rcp_version

String

Thread - RCP Version

routers[].leader_service.partition_id

Number

Leader Service - Partition ID

routers[].leader_service.weighting

Number

Leader Service - Weighting

routers[].leader_service.full_network_data_version

Number

Leader Service - Full Network Data Version

routers[].leader_service.stable_network_data_version

Number

Leader Service - Stable Network Data Version

routers[].border_router_service.state

String

Border Router Service - State

routers[].border_router_service.nat64_local_prefix

String

Border Router Service - NAT64 Local Prefix

routers[].border_router_service.nat64_favored_prefix

String

Border Router Service - NAT64 Favored Prefix

routers[].border_router_service.nat64_favored_preference

String

Border Router Service - NAT64 Favored Preference

routers[].border_router_service.nat64_omr_local_prefix

String

Border Router Service - OMR Local Prefix

routers[].border_router_service.nat64_omr_favored_prefix

String

Border Router Service - OMR Favored Prefix

routers[].border_router_service.nat64_omr_favored_preference

String

Border Router Service - OMR Favored Preference

routers[].border_router_service.nat64_onlink_local_prefix

String

Border Router Service - NAT64 On-Link Local Prefix

routers[].border_router_service.nat64_onlink_favored_prefix

String

Border Router Service - NAT64 On-Link Favored Prefix

routers[].border_router_service.nat64_onlink_favored_preference

String

Border Router Service - NAT64 On-Link Favored Preference

routers[].backbone_border_router_service.state

String

Backbone Border Router Service - State

routers[].commissioner_service.state

String

Commissioner - State

routers[].border_agent_service.state

String

Border Agent Service - State

routers[].border_agent_service.udp_port

Number

Border Agent Service - UDP Port

routers[].nat64_service.prefix_manager_state

String

NAT64 Service - Prefix Manager STate

routers[].nat64_service.translator_state

String

NAT64 Service - Translator State

routers[].nat64_service.translator_cidr

String

NAT64 Service - Translator CIDR

routers[].network_config.id

Number

Network Config - Unique Identifier

routers[].network_config.channel

Number

Network Config - Channel

routers[].network_config.channel_mask

String

Network Config - Channel Mask

routers[].network_config.ext_pan_id

String

Network Config - Extended Pan ID

routers[].network_config.mesh_local_prefix

String

Network Config - Mesh Local Prefix

routers[].network_config.network_key

String

Network Config - Network Key

routers[].network_config.network_name

String

Network Config - Network Name

routers[].network_config.pan_id

String

Network Config - PAN ID

routers[].network_config.pskc

String

Network Config - PSKC

routers[].network_config.obtain_network_key_enabled

Boolean

Network Config - Obtain Network Key Enabled

routers[].network_config.native_commissioning_enabled

Boolean

Network Config - Native Commissioning Enabled

routers[].network_config.routers_enabled

Boolean

Network Config - Routers Enabled

routers[].network_config.external_commissioning_enabled

Boolean

Network Config - External Commissioning Enabled

routers[].network_config.beacons_enabled

Boolean

Network Config - Beacons Enabled

routers[].network_config.commercial_commissioning_enabled

Boolean

Network Config - Commercial Commissioning Enabled

routers[].network_config.autonomous_enrollment_enabled

Boolean

Network Config - Autonomous Enrollment Enabled

routers[].network_config.network_key_provisioning_enabled

Boolean

Network Config - Network Key Provisioning Enabled

routers[].network_config.non_ccm_routers_enabled

Boolean

Network Config - Non-CCM Routers Enabled

routers[].network_config.active_timestamp

Number

Network Config - Active Timestamp

clients[].id

Number

The client device ID.

clients[].create_time

String

The create time.

clients[].update_time

String

The last update time.

clients[].org_id

Number

The organization identifier, valid when enabling HIQ feature.

clients[].location_id

Number

The location identifier

clients[].device_id

Number

The associate device identifier

clients[].hostname

String

The hostname of the client

clients[].alias

String

The alias of the client

clients[].mac_address

String

The MAC address of the client

clients[].ip_address

String

The IP address of the client

clients[].ipv6_address

String

The IPv6 address of the client

clients[].os_type

String

The OS type of the client

clients[].username

String

The username of the client

clients[].user_profile_name

String

The user profile name of the client

clients[].connected

Boolean

Client is connected or not

clients[].online_time

String

The online time for the client

clients[].offline_time

String

The offline time for the client

clients[].vlan

Number

The associate VLAN

clients[].connection_type

Number

The connection type

clients[].ssid

String

The SSID

clients[].port

String

The associate device port

clients[].org_name

String

The organization name for the client

clients[].device_function

Number

The associate device function

clients[].device_mac_address

String

The associate device MAC address

clients[].device_name

String

The associate device name

clients[].auth

Number

The authenticate type of the client

clients[].channel

Number

The channel of the client

clients[].client_health

Number

The health score of the client

clients[].application_health

Number

The health score of the client application

clients[].radio_health

Number

The health score of the client radio

clients[].network_health

Number

The health score of client network

clients[].radio_type

Number

The radio type of the client

clients[].encryption_method

Number

The encryption method of the client

clients[].interface_name

String

The interface name of the client

clients[].bssid

String

The bssid of the client

clients[].rssi

Number

The rssi of the client

clients[].snr

Number

The snr of the client

clients[].location_id

Number

The location id of the client

clients[].description

String

The description of the client

clients[].category

String

The category of the client

clients[].mobility

String

The mobility of the client

clients[].port_type_name

String

The port type name of the client

clients[].wing_ap

Boolean

The client associated device is wing ap or not

clients[].vendor

String

The vendor of the client

clients[].locations[].id

Number

The location identifier

clients[].locations[].name

String

The unique name of location

HTTP Response

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

{
  "neighbors" : [ {
    "parent_device_id" : 1,
    "child_device_id" : 2,
    "last_reported_time" : 1
  } ],
  "routers" : [ {
    "id" : 1,
    "org_id" : 0,
    "owner_id" : 0,
    "device_id" : 1,
    "serial_number" : "serial-number",
    "eui64" : "eui-64",
    "ext_mac" : "ext-mac",
    "rloc16" : "rloc-16",
    "global_ipv6" : "global-ipv6",
    "tx_power" : 0,
    "region" : "",
    "thread_platform" : "",
    "device_role" : "MANAGED",
    "router_interface" : {
      "interface_name" : "",
      "is_active" : false,
      "is_broadcast" : false,
      "is_loopback" : false,
      "is_point_to_point" : false,
      "is_running" : false,
      "is_arp" : false,
      "is_promisc" : false,
      "is_all_multi" : false,
      "is_multicast" : false,
      "is_dynamic" : false,
      "mtu" : 0,
      "hw_mac_address" : "",
      "ipv4" : "",
      "ipv4_mask" : "",
      "ipv4_broadcast" : "",
      "ipv6_settings" : [ ]
    },
    "veth0" : {
      "interface_name" : "",
      "is_active" : false,
      "is_broadcast" : false,
      "is_loopback" : false,
      "is_point_to_point" : false,
      "is_running" : false,
      "is_arp" : false,
      "is_promisc" : false,
      "is_all_multi" : false,
      "is_multicast" : false,
      "is_dynamic" : false,
      "mtu" : 0,
      "hw_mac_address" : "",
      "ipv4" : "",
      "ipv4_mask" : "",
      "ipv4_broadcast" : "",
      "ipv6_settings" : [ ]
    },
    "network_data" : {
      "length" : 0,
      "max_length" : 0,
      "net_data_on_mesh_prefixes" : [ ],
      "net_data_routes" : [ ],
      "net_data_services" : [ ]
    },
    "thread_mle_link_mode" : {
      "rx_on_when_idle" : false,
      "full_thread_device" : false,
      "full_network_data" : false
    },
    "thread_version" : {
      "thread_version" : "",
      "build_version" : "",
      "api_version" : "",
      "rcp_version" : ""
    },
    "leader_service" : {
      "partition_id" : 0,
      "weighting" : 0,
      "full_network_data_version" : 0,
      "stable_network_data_version" : 0
    },
    "border_router_service" : {
      "state" : "",
      "nat64_local_prefix" : "",
      "nat64_favored_prefix" : "",
      "nat64_favored_preference" : "",
      "nat64_omr_local_prefix" : "",
      "nat64_omr_favored_prefix" : "",
      "nat64_omr_favored_preference" : "",
      "nat64_onlink_local_prefix" : "",
      "nat64_onlink_favored_prefix" : "",
      "nat64_onlink_favored_preference" : ""
    },
    "backbone_border_router_service" : {
      "state" : ""
    },
    "border_agent_service" : {
      "state" : "",
      "udp_port" : 0
    },
    "commissioner_service" : {
      "state" : ""
    },
    "nat64_service" : {
      "prefix_manager_state" : "",
      "translator_state" : "",
      "translator_cidr" : ""
    },
    "network_config" : {
      "id" : 0,
      "channel" : 0,
      "channel_mask" : "",
      "ext_pan_id" : "",
      "mesh_local_prefix" : "",
      "network_key" : "",
      "network_name" : "",
      "pan_id" : "",
      "pskc" : "",
      "obtain_network_key_enabled" : false,
      "native_commissioning_enabled" : false,
      "routers_enabled" : false,
      "external_commissioning_enabled" : false,
      "beacons_enabled" : false,
      "commercial_commissioning_enabled" : false,
      "autonomous_enrollment_enabled" : false,
      "network_key_provisioning_enabled" : false,
      "non_ccm_routers_enabled" : false,
      "active_timestamp" : 0
    },
    "active_clients" : 0,
    "hostname" : "host-name",
    "last_reported" : "1970-01-01T00:00:00.000+0000",
    "thread_connected" : true
  } ],
  "clients" : [ {
    "id" : 1,
    "create_time" : "2024-04-03T19:56:21.000+0000",
    "update_time" : "2024-04-03T19:56:21.000+0000",
    "org_id" : 0,
    "location_id" : 1,
    "device_id" : 1,
    "hostname" : "Hostname 2",
    "mac_address" : "CVFOVMRVXOHM",
    "ip_address" : "192.168.56.2",
    "ipv6_address" : "0000:0000:0000:0000:0000:0000:0000:0000 ",
    "os_type" : "Mac",
    "username" : "",
    "user_profile_name" : "",
    "connected" : true,
    "online_time" : "2024-04-03T19:56:21.000+0000",
    "offline_time" : "2024-04-03T19:56:21.000+0000",
    "vlan" : 1,
    "connection_type" : 0,
    "ssid" : "SSID 2",
    "port" : "22",
    "org_name" : "",
    "device_function" : 0,
    "device_mac_address" : "PO9C3C3XP6BH",
    "device_name" : "test-device-2",
    "auth" : 0,
    "channel" : 0,
    "client_health" : 0,
    "application_health" : 0,
    "radio_health" : 0,
    "network_health" : 0,
    "radio_type" : 0,
    "encryption_method" : 0,
    "interface_name" : "",
    "bssid" : "",
    "rssi" : 0,
    "snr" : 0,
    "description" : "",
    "category" : "",
    "mobility" : "",
    "port_type_name" : "",
    "wing_ap" : false,
    "vendor" : "",
    "locations" : [ {
      "id" : 1,
      "name" : "test-location"
    } ],
    "alias" : "Alias 2"
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/thread/topology?networkConfigIds=1%2C2&routerFields=DEVICE_ID%2CSERIAL_NUMBER&routerViews=BASIC&clientViews=THREAD&clientFields=ID%2CORG_ID' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE4MSwiZXhwIjoxNzEyNzc4OTgxfQ.764zU3FrIUrpSoZgyq3pLyouyWkc0vYfgOcbLi24lqU'

Get Thread Routers

GET /thread/routers

Request Parameters

Parameter Description

ids

Thread Router UIDs

page

Page

limit

Limit

folderId

Location/Folder ID of the Thread Network

sortField

Sort field

sortOrder

Sort Order

views

Thread Router Views

fields

Thread Router Fields

HTTP Request

GET /thread/routers?ids=1%2C2&page=1&limit=10&folderId=438086664193&sortField=SERIAL_NUMBER&sortOrder=ASC&views=BASIC&fields=DEVICE_ID%2CSERIAL_NUMBER HTTP/1.1
Host: api.extremecloudiq.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE4MSwiZXhwIjoxNzEyNzc4OTgxfQ.764zU3FrIUrpSoZgyq3pLyouyWkc0vYfgOcbLi24lqU

Response Fields

Path Type Description

data[].id

Number

Thread Router Unique ID

data[].org_id

Number

Org ID

data[].owner_id

Number

Owner ID

data[].device_id

Number

Device Unique ID

data[].serial_number

String

Device Serial Number

data[].eui64

String

EUI 64

data[].ext_mac

String

Extended Mac Address

data[].rloc16

String

RLOC16

data[].global_ipv6

String

Global IPv6

data[].tx_power

Number

TX Power

data[].region

String

Region

data[].thread_platform

String

Thread Platform

data[].device_role

String

Device Role

data[].active_clients

Number

Active Thread Clients Count

data[].hostname

String

Device Hostname

data[].last_reported

String

Last Reported Time by AP

data[].thread_connected

Boolean

Thread Connected

data[].router_interface.interface_name

String

Router Interface Name

data[].router_interface.is_active

Boolean

Router Interface - Active

data[].router_interface.is_broadcast

Boolean

Router Interface - Broadcast

data[].router_interface.is_loopback

Boolean

Router Interface - Loopback

data[].router_interface.is_point_to_point

Boolean

Router Interface - Point to Point

data[].router_interface.is_running

Boolean

Router Interface - Running

data[].router_interface.is_arp

Boolean

Router Interface - ARP

data[].router_interface.is_promisc

Boolean

Router Interface - Promisc

data[].router_interface.is_all_multi

Boolean

Router Interface - All Multi

data[].router_interface.is_multicast

Boolean

Router Interface - Multicast

data[].router_interface.is_dynamic

Boolean

Router Interface - Dynamic

data[].router_interface.mtu

Number

Router Interface - MTU

data[].router_interface.hw_mac_address

String

Router Interface - Mac Address

data[].router_interface.ipv4

String

Router Interface - IPv4

data[].router_interface.ipv4_mask

String

Router Interface - Mask

data[].router_interface.ipv4_broadcast

String

Router Interface - IPv4 Broadcast

data[].router_interface.ipv6_settings

Array

Router Interface - IPv6 Settings

data[].veth0.interface_name

String

VETH0 - Interface Name

data[].veth0.is_active

Boolean

VETH0 - Active

data[].veth0.is_broadcast

Boolean

VETH0 - Broadcast

data[].veth0.is_loopback

Boolean

VETH0 - Loopback

data[].veth0.is_point_to_point

Boolean

VETH0 - Point to Point

data[].veth0.is_running

Boolean

VETH0 - Running

data[].veth0.is_arp

Boolean

VETH0 - ARP

data[].veth0.is_promisc

Boolean

VETH0 - Promisc

data[].veth0.is_all_multi

Boolean

VETH0 - Multi

data[].veth0.is_multicast

Boolean

VETH0 - Multicast

data[].veth0.is_dynamic

Boolean

VETH0 - Dynamic

data[].veth0.mtu

Number

VETH0 - MTU

data[].veth0.hw_mac_address

String

VETH0 - HW Mac Address

data[].veth0.ipv4

String

VETH0 - IPv4 Address

data[].veth0.ipv4_mask

String

VETH0 - IPv4 Address Mask

data[].veth0.ipv4_broadcast

String

VETH0 - IPv4 Address Broadcast

data[].veth0.ipv6_settings

Array

VETH0 - IPv6 Settings

data[].network_data.length

Number

Network Data - Length

data[].network_data.max_length

Number

Network Data - Max Length

data[].network_data.net_data_on_mesh_prefixes

Array

Network Data - Net Data On-Mesh Prefixes

data[].network_data.net_data_routes

Array

Network Data - Net Data Routes

data[].network_data.net_data_services

Array

Network Data - Services

data[].thread_mle_link_mode.rx_on_when_idle

Boolean

Thread MLE Link Mode - Rx-On When Idle

data[].thread_mle_link_mode.full_thread_device

Boolean

Thread MLE Link Mode - Full Thread Device

data[].thread_mle_link_mode.full_network_data

Boolean

Thread MLE Link Mode - Full Network Data

data[].thread_version.thread_version

String

Thread - Version

data[].thread_version.build_version

String

Thread - Build Version

data[].thread_version.api_version

String

Thread - API Version

data[].thread_version.rcp_version

String

Thread - RCP Version

data[].leader_service.partition_id

Number

Leader Service - Partition ID

data[].leader_service.weighting

Number

Leader Service - Weighting

data[].leader_service.full_network_data_version

Number

Leader Service - Full Network Data Version

data[].leader_service.stable_network_data_version

Number

Leader Service - Stable Network Data Version

data[].border_router_service.state

String

Border Router Service - State

data[].border_router_service.nat64_local_prefix

String

Border Router Service - NAT64 Local Prefix

data[].border_router_service.nat64_favored_prefix

String

Border Router Service - NAT64 Favored Prefix

data[].border_router_service.nat64_favored_preference

String

Border Router Service - NAT64 Favored Preference

data[].border_router_service.nat64_omr_local_prefix

String

Border Router Service - OMR Local Prefix

data[].border_router_service.nat64_omr_favored_prefix

String

Border Router Service - OMR Favored Prefix

data[].border_router_service.nat64_omr_favored_preference

String

Border Router Service - OMR Favored Preference

data[].border_router_service.nat64_onlink_local_prefix

String

Border Router Service - NAT64 On-Link Local Prefix

data[].border_router_service.nat64_onlink_favored_prefix

String

Border Router Service - NAT64 On-Link Favored Prefix

data[].border_router_service.nat64_onlink_favored_preference

String

Border Router Service - NAT64 On-Link Favored Preference

data[].backbone_border_router_service.state

String

Backbone Border Router Service - State

data[].commissioner_service.state

String

Commissioner - State

data[].border_agent_service.state

String

Border Agent Service - State

data[].border_agent_service.udp_port

Number

Border Agent Service - UDP Port

data[].nat64_service.prefix_manager_state

String

NAT64 Service - Prefix Manager STate

data[].nat64_service.translator_state

String

NAT64 Service - Translator State

data[].nat64_service.translator_cidr

String

NAT64 Service - Translator CIDR

data[].network_config.id

Number

Network Config - Unique Identifier

data[].network_config.channel

Number

Network Config - Channel

data[].network_config.channel_mask

String

Network Config - Channel Mask

data[].network_config.ext_pan_id

String

Network Config - Extended Pan ID

data[].network_config.mesh_local_prefix

String

Network Config - Mesh Local Prefix

data[].network_config.network_key

String

Network Config - Network Key

data[].network_config.network_name

String

Network Config - Network Name

data[].network_config.pan_id

String

Network Config - PAN ID

data[].network_config.pskc

String

Network Config - PSKC

data[].network_config.obtain_network_key_enabled

Boolean

Network Config - Obtain Network Key Enabled

data[].network_config.native_commissioning_enabled

Boolean

Network Config - Native Commissioning Enabled

data[].network_config.routers_enabled

Boolean

Network Config - Routers Enabled

data[].network_config.external_commissioning_enabled

Boolean

Network Config - External Commissioning Enabled

data[].network_config.beacons_enabled

Boolean

Network Config - Beacons Enabled

data[].network_config.commercial_commissioning_enabled

Boolean

Network Config - Commercial Commissioning Enabled

data[].network_config.autonomous_enrollment_enabled

Boolean

Network Config - Autonomous Enrollment Enabled

data[].network_config.network_key_provisioning_enabled

Boolean

Network Config - Network Key Provisioning Enabled

data[].network_config.non_ccm_routers_enabled

Boolean

Network Config - Non-CCM Routers Enabled

data[].network_config.active_timestamp

Number

Network Config - Active Timestamp

page

Number

The current page number.

count

Number

The element count of the current page.

total_pages

Number

The total page number based on request page size.

total_count

Number

The total element count.

HTTP Response

HTTP/1.1 200 OK
Content-Length: 3571
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: 7240

{
  "page" : 2,
  "count" : 10,
  "total_pages" : 2,
  "total_count" : 15,
  "data" : [ {
    "id" : 1,
    "org_id" : 0,
    "owner_id" : 0,
    "device_id" : 1,
    "serial_number" : "serial-number",
    "eui64" : "eui-64",
    "ext_mac" : "ext-mac",
    "rloc16" : "rloc-16",
    "global_ipv6" : "global-ipv6",
    "tx_power" : 0,
    "region" : "",
    "thread_platform" : "",
    "device_role" : "MANAGED",
    "router_interface" : {
      "interface_name" : "",
      "is_active" : false,
      "is_broadcast" : false,
      "is_loopback" : false,
      "is_point_to_point" : false,
      "is_running" : false,
      "is_arp" : false,
      "is_promisc" : false,
      "is_all_multi" : false,
      "is_multicast" : false,
      "is_dynamic" : false,
      "mtu" : 0,
      "hw_mac_address" : "",
      "ipv4" : "",
      "ipv4_mask" : "",
      "ipv4_broadcast" : "",
      "ipv6_settings" : [ ]
    },
    "veth0" : {
      "interface_name" : "",
      "is_active" : false,
      "is_broadcast" : false,
      "is_loopback" : false,
      "is_point_to_point" : false,
      "is_running" : false,
      "is_arp" : false,
      "is_promisc" : false,
      "is_all_multi" : false,
      "is_multicast" : false,
      "is_dynamic" : false,
      "mtu" : 0,
      "hw_mac_address" : "",
      "ipv4" : "",
      "ipv4_mask" : "",
      "ipv4_broadcast" : "",
      "ipv6_settings" : [ ]
    },
    "network_data" : {
      "length" : 0,
      "max_length" : 0,
      "net_data_on_mesh_prefixes" : [ ],
      "net_data_routes" : [ ],
      "net_data_services" : [ ]
    },
    "thread_mle_link_mode" : {
      "rx_on_when_idle" : false,
      "full_thread_device" : false,
      "full_network_data" : false
    },
    "thread_version" : {
      "thread_version" : "",
      "build_version" : "",
      "api_version" : "",
      "rcp_version" : ""
    },
    "leader_service" : {
      "partition_id" : 0,
      "weighting" : 0,
      "full_network_data_version" : 0,
      "stable_network_data_version" : 0
    },
    "border_router_service" : {
      "state" : "",
      "nat64_local_prefix" : "",
      "nat64_favored_prefix" : "",
      "nat64_favored_preference" : "",
      "nat64_omr_local_prefix" : "",
      "nat64_omr_favored_prefix" : "",
      "nat64_omr_favored_preference" : "",
      "nat64_onlink_local_prefix" : "",
      "nat64_onlink_favored_prefix" : "",
      "nat64_onlink_favored_preference" : ""
    },
    "backbone_border_router_service" : {
      "state" : ""
    },
    "border_agent_service" : {
      "state" : "",
      "udp_port" : 0
    },
    "commissioner_service" : {
      "state" : ""
    },
    "nat64_service" : {
      "prefix_manager_state" : "",
      "translator_state" : "",
      "translator_cidr" : ""
    },
    "network_config" : {
      "id" : 0,
      "channel" : 0,
      "channel_mask" : "",
      "ext_pan_id" : "",
      "mesh_local_prefix" : "",
      "network_key" : "",
      "network_name" : "",
      "pan_id" : "",
      "pskc" : "",
      "obtain_network_key_enabled" : false,
      "native_commissioning_enabled" : false,
      "routers_enabled" : false,
      "external_commissioning_enabled" : false,
      "beacons_enabled" : false,
      "commercial_commissioning_enabled" : false,
      "autonomous_enrollment_enabled" : false,
      "network_key_provisioning_enabled" : false,
      "non_ccm_routers_enabled" : false,
      "active_timestamp" : 0
    },
    "active_clients" : 0,
    "hostname" : "host-name",
    "last_reported" : "1970-01-01T00:00:00.000+0000",
    "thread_connected" : true
  } ]
}

cURL Request

$ curl 'https://api.extremecloudiq.com/thread/routers?ids=1%2C2&page=1&limit=10&folderId=438086664193&sortField=SERIAL_NUMBER&sortOrder=ASC&views=BASIC&fields=DEVICE_ID%2CSERIAL_NUMBER' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjdXN0MDAxLmNvbSIsInVzZXJfaWQiOjEsInJvbGUiOiJBZG1pbmlzdHJhdG9yIiwib3duZXJfaWQiOjEwMiwiZGF0YV9jZW50ZXIiOiJVU19XRVNUIiwic2NvcGVzIjpbImxvZ291dCIsImF1dGgiLCJhdXRoOnIiLCJ0b2tlbjpuZXciLCJwZXJtOmNoZWNrIiwibHJvIiwibHJvOnIiLCJhY2NvdW50IiwiYWNjb3VudDpzd2l0Y2giLCJhY2NvdW50OnIiLCJ2aXE6YmFja3VwIiwidXNlciIsInVzZXItbWU6ciIsInVzZXI6ciIsImhpcSIsImhpcTpyIiwib3JnIiwib3JnOm5ldyIsIm9yZzpkZWwiLCJvcmc6cmVuYW1lIiwiaGlxLmN0eCIsImhpcS5jdHg6ciIsImhpcS5jdHg6dyIsImRldmljZSIsImRldmljZTpyIiwiZGV2aWNlOmxpc3QiLCJkZXZpY2U6dmlldyIsImRldmljZTpuZXciLCJkZXZpY2U6ZGVsIiwiZGV2aWNlOmNsaSIsImRldmljZTpkZXBsb3kiLCJkZXZpY2U6bWFuYWdlIiwiZGV2aWNlOnVubWFuYWdlIiwiZGV2aWNlOnJlYm9vdCIsImRldmljZTpyZXNldCIsImRldmljZTp0aHJlYWQtY29tbWlzc2lvbmVyIiwiY2xpZW50IiwiY2xpZW50OnIiLCJsb2NhdGlvbnMiLCJsb2NhdGlvbnM6ciIsIm5ldHdvcmstcG9saWN5IiwicG9saWN5OnNzaWQiLCJuZXR3b3JrLXBvbGljeTpyIiwibmV0d29yay1zY29yZWNhcmQiLCJuZXR3b3JrLXNjb3JlY2FyZDpyIiwic3NpZCIsInNzaWQ6ciIsInBjZzprZXkiLCJwY2c6a2V5OnIiLCJzdWJzY3JpcHRpb25zLXdlYmhvb2siLCJzdWJzY3JpcHRpb25zLXdlYmhvb2s6ciIsImNjZyIsImNjZzpyIiwibG9nIiwibG9nOnIiLCJjd3AiLCJjd3A6ciIsInNtcy10bXBsIiwic21zLXRtcGw6ciIsImNsYXNzLXJ1bGUiLCJjbGFzcy1ydWxlOnIiLCJ1c2VyLXByb2ZpbGUiLCJ1c2VyLXByb2ZpbGU6ciIsInJhZGl1cy1wcm94eSIsInJhZGl1cy1wcm94eTpyIiwicmFkaXVzLXNlcnZlciIsInJhZGl1cy1zZXJ2ZXI6ciIsInVzZXJncm91cCIsInVzZXJncm91cDpyIiwiZGVwbG95bWVudCIsImRlcGxveW1lbnQ6ciIsImFkLXNlcnZlciIsImFkLXNlcnZlcjpyIiwiYWxlcnQiLCJhbGVydDpyIiwiYWxlcnQtcG9saWNpZXMiLCJhbGVydC1wb2xpY2llczpyIiwiYWxlcnQtc3Vic2NyaXB0aW9ucyIsImFsZXJ0LXN1YnNjcmlwdGlvbnM6ciIsImFwcCIsImFwcGxpY2F0aW9uOnIiLCJsMy1hZGRyZXNzLXByb2ZpbGUiLCJsMy1hZGRyZXNzLXByb2ZpbGU6ciIsInZsYW4tcHJvZmlsZSIsInZsYW4tcHJvZmlsZTpyIiwiZW5kdXNlciIsImVuZHVzZXI6ciIsInJhZGl1cy1jbGllbnQtb2JqZWN0IiwicmFkaXVzLWNsaWVudC1vYmplY3Q6ciIsImxkYXAtc2VydmVyIiwibGRhcC1zZXJ2ZXI6ciIsImVtYWlsLXRlbXBsYXRlIiwiZW1haWwtdGVtcGxhdGU6ciIsImNlcnRpZmljYXRlIiwiY2VydGlmaWNhdGU6ciIsInJhZGlvLXByb2ZpbGUiLCJyYWRpby1wcm9maWxlOnIiLCJpb3QtcHJvZmlsZSIsImlvdC1wcm9maWxlOnIiLCJjbGllbnQtbW9uaXRvci1wcm9maWxlIiwiY2xpZW50LW1vbml0b3ItcHJvZmlsZTpyIiwiY29waWxvdC1jb25uZWN0aXZpdHktd2lyZWQ6ciIsImNvcGlsb3QtY29ubmVjdGl2aXR5LXdpcmVsZXNzOnIiLCJjb3BpbG90LWFub21hbGllczpyIiwibGljZW5zZXMiLCJsaWNlbnNlczpyIiwiY29waWxvdC1hc3N1cmFuY2Utc2NhbnM6ciIsInBhY2tldC1jYXB0dXJlIiwicGFja2V0LWNhcHR1cmU6ciIsImNvdW50cnkiLCJjb3VudHJ5OnIiLCJjYXMiLCJjYXM6ciIsImNhcy1wb2xpY2llcyIsImNhcy1wb2xpY2llczpyIiwiY2FzLW1ldGFkYXRhOnIiLCJjbnMtc3Vic2NyaXB0aW9ucyIsImNucy1zdWJzY3JpcHRpb25zOnIiXSwiY3VzdG9tZXJfaWQiOjEsImN1c3RvbWVyX21vZGUiOjAsImhpcV9lbmFibGVkIjp0cnVlLCJvcmdfaWQiOjAsInF1b3RhIjoiNzUwMDt3PTM2MDAiLCJzaGFyZCI6IlVTIiwiaXNzIjoiYXBpLmV4dHJlbWVjbG91ZGlxLmNvbSIsImlhdCI6MTcxMjE3NDE4MSwiZXhwIjoxNzEyNzc4OTgxfQ.764zU3FrIUrpSoZgyq3pLyouyWkc0vYfgOcbLi24lqU'